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

Use poetry #46

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open

Use poetry #46

wants to merge 7 commits into from

Conversation

JJMinton
Copy link

This PR is slightly opinionated and contains a number of different changes, but they're all things I did a part of getting the repo installed and tests running (although still not passing as per #40). I'm happy to rework it to include/exclude any of the elements or break it up into more focused changes.

The contributions are:

  • Use poetry: this is a newer dependency management solution with growing popularity. It's more declarative than setuptools, which I find easier to use, It also locks dependencies, which improves reproducibility between contributors.
  • add a .gitignore file for convenience while developing.
  • Package
    • Update pyemd as this was failing to build with a newer version of cython
    • Add missing dependencies
    • Add pyrouge as an extra
    • Add pytest as a development dependency. Pytest captures stdout and stderr output while running tests which means the noise produced by downloading/loading models and data from various packages is presented in a more readable format.
  • Update the readme:
    • Reorganise it to focus more on the package usage
    • Expand the installation instructions to cover some of the metric specific instructions
    • List metric references for import/CLI options

Jeremy added 5 commits September 10, 2023 19:52
Poetry's feature to lock package versions should help to provide a
definitive set of dependents against which the tests are checked.
- Rearrange to focus on the usability of the package
- Expand installation instructions - especially around additional
requirements of some metrics
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