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

Improve setup and docs #239

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

Conversation

fraser-langton
Copy link

Just adding a bit more docs on getting setup, just feedback from a first timer setting up the repo :)

I went with a basic requirements-dev.txt to hold the requirements in one spot (updated tox to reference them as well) - but maybe consider poetry?

I also tweaked the black, isort, mypy configs so they all run using <command> . (and only runs on project files) - for me I think that's kind of convention for those tools.

I also ran isort, and added to tox.ini

@seddonym seddonym self-requested a review October 14, 2024 16:14
Copy link
Owner

@seddonym seddonym left a comment

Choose a reason for hiding this comment

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

Thanks for looking at this!

The contributing docs are indeed in need of a bit of love. Thanks for improving them.

Looks like the checks aren't all passing though.

pytest~=7.4.0
pytest-cov~=4.1.0
PyYAML~=6.0.1
-r requirements-dev.txt
Copy link
Owner

Choose a reason for hiding this comment

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

Much nicer, thanks!

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