Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Overhaul using scientific-python cookie #18

Draft
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

smithara
Copy link
Member

@smithara smithara commented Nov 25, 2024

Implements a modern package development setup by applying the scientific-python cookie recipe.

It is applied using copier and can be updated with e.g.:

pipx install copier
pipx inject copier copier-templates-extensions
copier update --trust

or re-applied with copier copy gh:scientific-python/cookie . --trust

(but check the instructions from the cookie repo and from copier)

To do:

  • decide how change log should be handled

To do after merging:

  • set 2.1.0 as the git tag; verify the package still works as expected; test the release process, then enable pushing to real pypi
  • Re-enable skipped checks, one at a time, and fix the code for them:
    • Typing (mypy)
    • Linting with Ruff
    • Other stuff like the spell checker
  • Set up readthedocs and a minimal documentation

sp-repo-review validates the repo, e.g. https://learn.scientific-python.org/development/guides/repo-review/?repo=smithara%2Fppigrf&branch=use-scientific-python-cookie

@smithara smithara force-pushed the use-scientific-python-cookie branch from b8ded96 to 0ba0aad Compare November 27, 2024 19:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant