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 tox and githooks #1

Merged
merged 2 commits into from
Nov 18, 2019
Merged

Add tox and githooks #1

merged 2 commits into from
Nov 18, 2019

Conversation

dbolt
Copy link

@dbolt dbolt commented Nov 17, 2019

Overview

Added tox

  • pytests
  • code coverage
  • code linters
  • sphinx docs

Added git hooks

  • when a git push is made unit tests, docs, and linters must pass in order to be pushed

Testing

confirmed tests are run, code coverage is produced, docs are produced, all linters are called, and that on push these commands are run.

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@dbolt dbolt requested a review from avawang1 November 17, 2019 21:48
tox.ini Outdated
deps =
black
commands =
black --line-length 100 ./ {posargs}
Copy link
Contributor

Choose a reason for hiding this comment

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

How can we supply the CLI options for black into setup.cfg like flake8 and isort?

Copy link
Author

Choose a reason for hiding this comment

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

Looks like black looks in pyproject.toml https://github.com/psf/black#where-black-looks-for-the-file . Will update to use this.

Copy link
Contributor

@avawang1 avawang1 left a comment

Choose a reason for hiding this comment

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

Testing

Derek Bolt🐾 added 2 commits November 18, 2019 14:09
- pytests
- code coverage
- code linters
- sphinx docs
When a git push is made unit tests, docs, and linters must pass in
order to be pushed.
@avawang1 avawang1 merged commit d9bec0b into master Nov 18, 2019
@dbolt dbolt deleted the derebolt branch November 18, 2019 22:19
kshitijc added a commit that referenced this pull request Nov 29, 2021
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.

None yet

2 participants