https://github.com/astrojuanlu/cookiecutter-pylib

cookiecutter template for pure Python libraries. As simple as possible. No magic.
https://github.com/astrojuanlu/cookiecutter-pylib

Last synced: 2 months ago
JSON representation

cookiecutter template for pure Python libraries. As simple as possible. No magic.

• Host: GitHub
• URL: https://github.com/astrojuanlu/cookiecutter-pylib
• Owner: astrojuanlu
• License: mit
• Created: 2020-05-03T16:21:51.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-09-09T16:43:01.000Z (over 2 years ago)
• Last Synced: 2023-03-24T01:51:44.103Z (almost 2 years ago)
• Language: Python
• Size: 38.1 KB
• Stars: 23
• Watchers: 3
• Forks: 4
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# cookiecutter-pylib

[![No Maintenance Intended](http://unmaintained.tech/badge.svg)](http://unmaintained.tech/)

_This project is archived, use https://github.com/astrojuanlu/copier-pylib instead_

[Cookiecutter](https://github.com/audreyr/cookiecutter) template for pure Python libraries.

_As simple as possible. No magic._

## Features

- [flit] for simple packaging.

- [pytest] for testing.

- [tox] for automation of test runners and other stuff.

- [Sphinx] for documentation

- [GitHub Actions] for continuous integration and publishing to PyPI.

- [Read the Docs] for continuous documentation.

- [mypy] for type checks.

- [black] for automatic Python code formatting.

- [flake8], [isort] and [pydocstyle] for style checks.

- [pre-commit] for optional automation of style checks.

## Usage

Install `cookiecutter`:

```

pip install cookiecutter

```

Generate a Python package:

```

cookiecutter gh:astrojuanlu/cookiecutter-pylib

```

## License

[MIT License](LICENSE)

[cookiecutter]: https://github.com/audreyr/cookiecutter/

[mypy]: http://mypy.readthedocs.io/

[flit]: https://flit.readthedocs.io/

[pytest]: https://docs.pytest.org/

[Sphinx]: http://www.sphinx-doc.org/

[tox]: https://tox.readthedocs.io/

[black]: https://black.readthedocs.io/

[flake8]: https://flake8.pycqa.org/

[isort]: https://pycqa.github.io/isort/

[pydocstyle]: http://www.pydocstyle.org/

[pre-commit]: https://github.com/pre-commit/pre-commit

[GitHub Actions]: https://github.com/features/actions

[Read the Docs]: https://readthedocs.org