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

Project initialisation #1

Open
10 of 18 tasks
leroyvn opened this issue Dec 24, 2021 · 0 comments
Open
10 of 18 tasks

Project initialisation #1

leroyvn opened this issue Dec 24, 2021 · 0 comments

Comments

@leroyvn
Copy link
Owner

leroyvn commented Dec 24, 2021 •
edited
Loading

This issue contains the work breakdown for the initialisation of this project.

Basic setup

  • Add copier.yml based on existing templates
  • Add pyproject.toml template

Tasks

  • Implement task automation with duty
  • Add makefile
  • Add formatting tools: autoflake (for unused import removal), isort, Black
  • Add checks: mypy (and typing), flake8, formatting
  • Add testing framework: pytest (with xdoctest, coverage), nox
  • Add pre-commit support

Testing

  • Configure pytest and add test directory

Documentation

Continuous integration

  • Configure GitHub Actions
  • Configure Read the Docs

Virtual environment support

  • Document option to use an env manager
  • Add Conda dependency lock using conda-lock (supports PEP 621 AFAIK, can also lock reliably Pip deps using the Poetry solver)

GitHub project

  • Add tags
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@leroyvn