From d7a31333fe24009d23f3103e77381b12545f7bf1 Mon Sep 17 00:00:00 2001 From: Melissa DeLucchi <113376043+delucchi-cmu@users.noreply.github.com> Date: Fri, 8 Mar 2024 15:30:47 -0500 Subject: [PATCH] Apply PPT v2.0 (#217) * Apply PPT v2.0 * Move jupyter requirement. --- .copier-answers.yml | 2 +- .github/ISSUE_TEMPLATE/2-feature_request.md | 4 ++-- .github/workflows/smoke-test.yml | 8 ++++---- .setup_dev.sh | 1 + docs/requirements.txt | 12 +++++++----- pyproject.toml | 10 ++-------- 6 files changed, 17 insertions(+), 20 deletions(-) diff --git a/.copier-answers.yml b/.copier-answers.yml index 40019905..2878faf1 100644 --- a/.copier-answers.yml +++ b/.copier-answers.yml @@ -1,5 +1,5 @@ # Changes here will be overwritten by Copier -_commit: v1.5.3 +_commit: v2.0.0 _src_path: gh:lincc-frameworks/python-project-template author_email: lincc-frameworks-team@lists.lsst.org author_name: LINCC Frameworks diff --git a/.github/ISSUE_TEMPLATE/2-feature_request.md b/.github/ISSUE_TEMPLATE/2-feature_request.md index bcddd743..908ff720 100644 --- a/.github/ISSUE_TEMPLATE/2-feature_request.md +++ b/.github/ISSUE_TEMPLATE/2-feature_request.md @@ -7,7 +7,7 @@ assignees: '' --- -** Feature request** +**Feature request** **Before submitting** @@ -15,4 +15,4 @@ Please check the following: - [ ] I have described the purpose of the suggested change, specifying what I need the enhancement to accomplish, i.e. what problem it solves. - [ ] I have included any relevant links, screenshots, environment information, and data relevant to implementing the requested feature, as well as pseudocode for how I want to access the new functionality. -- [ ] If I have ideas for how the new feature could be implemented, I have provided explanations and/or pseudocode and/or task lists for the steps. \ No newline at end of file +- [ ] If I have ideas for how the new feature could be implemented, I have provided explanations and/or pseudocode and/or task lists for the steps. diff --git a/.github/workflows/smoke-test.yml b/.github/workflows/smoke-test.yml index 4d2e9511..4bf8bbb9 100644 --- a/.github/workflows/smoke-test.yml +++ b/.github/workflows/smoke-test.yml @@ -38,12 +38,12 @@ jobs: run: | python -m pytest - name: Send status to Slack app - if: ${{ failure() && github.event_name != 'workflow_dispatch' }} # Only post if the workflow failed and was not manually started. Customize this as necessary. + if: ${{ failure() && github.event_name != 'workflow_dispatch' }} id: slack uses: slackapi/slack-github-action@v1 with: # For posting a rich message using Block Kit - payload: | # The payload defined here can be customized to you liking https://api.slack.com/reference/block-kit/blocks + payload: | { "blocks": [ { @@ -57,7 +57,7 @@ jobs: "type": "section", "text": { "type": "mrkdwn", - "text": "GitHub Action build result: *${{ job.status }}* :${{ job.status }}:" # Note that we expect the slack workspace to have an emoji called “failed” in this case. + "text": "GitHub Action build result: *${{ job.status }}* :${{ job.status }}:" } }, { @@ -73,5 +73,5 @@ jobs: ] } env: - SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} # Here is where the webhook URL is provided + SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }} SLACK_WEBHOOK_TYPE: INCOMING_WEBHOOK \ No newline at end of file diff --git a/.setup_dev.sh b/.setup_dev.sh index 47bc27ae..d8cd955c 100644 --- a/.setup_dev.sh +++ b/.setup_dev.sh @@ -32,6 +32,7 @@ python -m pip install -e . > /dev/null echo "Installing developer dependencies in local environment" python -m pip install -e .'[dev]' > /dev/null +if [ -f docs/requirements.txt ]; then python -m pip install -r docs/requirements.txt; fi echo "Installing pre-commit" pre-commit install > /dev/null diff --git a/docs/requirements.txt b/docs/requirements.txt index 3ed756bf..a6fe8a63 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,9 +1,11 @@ + +ipykernel +ipython +jupytext +nbconvert +nbsphinx sphinx -sphinx-rtd-theme sphinx-autoapi sphinx-copybutton -nbsphinx -ipython -jupytext -jupyter +sphinx-rtd-theme git+https://github.com/astronomy-commons/hipscat.git@main diff --git a/pyproject.toml b/pyproject.toml index ee610501..29418743 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -34,20 +34,14 @@ documentation = "https://lsdb.readthedocs.io/" # On a mac, install optional dependencies with `pip install '.[dev]'` (include the single quotes) [project.optional-dependencies] dev = [ + "asv==0.6.3", # Used to compute performance benchmarks + "jupyter", # Clear notebook output "mypy", # Used for static type checking of files "pre-commit", # Used to run checks before finalizing a git commit "pylint", # Used for static linting of files "pytest", "pytest-cov", # Used to report total code coverage "pytest-mock", # Used to mock objects in tests - "sphinx", # Used to automatically generate documentation - "sphinx-rtd-theme", # Used to render documentation - "sphinx-autoapi", # Used to automatically generate api documentation - "nbconvert", # Needed for pre-commit check to clear output from Python notebooks - "nbsphinx", # Used to integrate Python notebooks into Sphinx documentation - "ipykernel", # Support for Jupyter notebooks - "ipython", # Also used in building notebooks into Sphinx - "asv==0.6.3", # Used to compute performance benchmarks ] [build-system]