Python Package

This is a minimal python package for a CLI app with automated unit tests and continuous integration bundled using poetry.

This project can take a lot of inspirations from pendulum, which is made by the developer of poetry.

Features

It has a LICENSE file
It has a README.md file
It is bundled using poetry
mkdocs documentation published using GitHub pages on a custom domain
Shipped with a VS Code's workspace file and recommended extensions
- Configured for python linting with pep8, pylint, mypy and pydocstyle
- Enables auto-formating with Google style using yapf and isort
An example package of an English dictionary with the following:
- Follows the guidelines specified by the mentioned linters
- Type hints and annotations with mypy
- Uses pathlib, logging and click
- Unit tested using pytest ([TODO] trying pytest-mock)
Automated testing using tox and stats using pytest-cov
Continuous integration (CI) using Travis-CI and GitHub badges using shields
[TODO] publish on PyPI (and maybe conda)
[TODO] Makefile and VS Code tasks
[TODO] use docker and kubernetes
[TODO] create a cookiecutter

The assumed operating system is Ubuntu and follow the documentation:

We recommend using VS Code and following the instructions provided here.

I would gladly accept any pull request to this repository.