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

Add pyproject.toml #464

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

freemansw1
Copy link
Member

@freemansw1 freemansw1 commented Nov 1, 2024

Resolves #442 and adds a (fairly basic) pyproject.toml to tobac.

Note that this is proposed as a merge to main.

  • Have you followed our guidelines in CONTRIBUTING.md?
  • Have you self-reviewed your code and corrected any misspellings?
  • Have you written documentation that is easy to understand?
  • Have you written descriptive commit messages?
  • Have you added NumPy docstrings for newly added functions?
  • Have you formatted your code using black?
  • If you have introduced a new functionality, have you added adequate unit tests?
  • Have all tests passed in your local clone?
  • If you have introduced a new functionality, have you added an example notebook?
  • Have you kept your pull request small and limited so that it is easy to review?
  • Have the newest changes from this branch been merged?

@freemansw1 freemansw1 added the enhancement Addition of new features, or improved functionality of existing features label Nov 1, 2024
@freemansw1 freemansw1 self-assigned this Nov 1, 2024
@freemansw1
Copy link
Member Author

The failing CI will be resolved after #465 is merged; we will wait to review/merge until that is merged.

Copy link

codecov bot commented Nov 8, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 60.67%. Comparing base (706b3ee) to head (e993b4f).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #464   +/-   ##
=======================================
  Coverage   60.67%   60.67%           
=======================================
  Files          23       23           
  Lines        3537     3537           
=======================================
  Hits         2146     2146           
  Misses       1391     1391           
Flag Coverage Δ
unittests 60.67% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Member

@w-k-jones w-k-jones left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thanks for adding this! Happy for this to be merged


[project]
name = "tobac"
version = "1.5.4"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a way to get the version from the __init__.py file as previously?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Addition of new features, or improved functionality of existing features
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add pyproject.toml for package setup
2 participants