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

Update and cleanup package #229

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

Update and cleanup package #229

wants to merge 27 commits into from

Conversation

pluflou
Copy link
Collaborator

@pluflou pluflou commented Jan 31, 2025

  • modernized package with pyproject.toml
    • added optional deps for meme to handle tests locally vs in forks vs on main repo GHA
    • added package versioning from git using setuptools-scm
  • cleaned up github actions workflows
    • renamed jobs for clarity
    • added option to run jobs on forks w/o meme. meme dependent tests will be skipped depending on which repo is running them.
    • added useful/pretty summary output for GHA test results
  • updated README
  • fixed a few typos

Note that with this structure, the dependencies go in pyproject.toml(as unpinned as possible), so the library can be installed without running into many issues resolving version constraints. If we want to pin versions for deploying on certain machines, the requirements.txt should be used with exact version pinning (equivalent to an environment.yml file with conda). For building and releasing (e.g. to PyPI), the pyproject.toml is used.

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.

2 participants