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.

Sign up for GitHub

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

Jump to bottom

Setup project automations - linting, testing, doc generation etc. #6

Open
9 of 11 tasks
stuaxo opened this issue Jun 5, 2019 · 2 comments
Open
9 of 11 tasks

Setup project automations - linting, testing, doc generation etc. #6

stuaxo opened this issue Jun 5, 2019 · 2 comments
Assignees
@stuaxo
Labels
project automation Project tools, e.g. testing, linting, CI etc.

Comments

@stuaxo
Copy link
Contributor

stuaxo commented Jun 5, 2019 •
edited
Loading

pyproject.toml:

  • sphinx
  • flake8
  • pytest
  • pytest-cov (test coverage)
  • black

pre-commit hook

  • black
  • pydocstyle - check docstrings.

Initial DEVELOPER.md

  • linting (flake8)
  • formatting (black)
  • testing (pytest)
  • test coverage (pytest-cov)

see also: #7 setup project integrations
@stuaxo stuaxo self-assigned this Jun 5, 2019
@stuaxo stuaxo changed the title Setup sphinx Repo setup tasks Jun 7, 2019
@stuaxo stuaxo assigned stuaxo and unassigned stuaxo Jun 7, 2019
@stuaxo
Copy link
Contributor Author

stuaxo commented Jun 8, 2019

I'm going to try and setup apidoc, and have sphinx setup with markdown support instead of REST, as it seems to have more uptake than REST these days.

APIdoc with setup to use numpy style comments seems like an OK combination.

@stuaxo
Copy link
Contributor Author

stuaxo commented Jan 28, 2020

Running through this very well tooled up tutorial
https://cjolowicz.github.io/posts/hypermodern-python-01-setup/

Definitely need to mention this in docs

@stuaxo stuaxo added the project automation Project tools, e.g. testing, linting, CI etc. label Jan 28, 2020
@stuaxo stuaxo changed the title Repo setup tasks Setup project automations - linting, testing, doc generation etc. Jan 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@stuaxo stuaxo

Labels
project automation Project tools, e.g. testing, linting, CI etc.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@stuaxo