copier_example#

Code CI Docs CI Test Coverage Latest PyPI version Apache License

This is where you should write a short paragraph that describes what your module does, how it does it, and why people should use it.

PyPI

pip install copier-example

Source code

coretl/copier-example

Documentation

https://coretl.github.io/copier-example

Releases

coretl/copier-example

This is a test repo.

This is where you should put some images or code snippets that illustrate some relevant examples. If it is a library then you might put some introductory code here:

from copier_example import __version__

print(f"Hello copier_example {__version__}")

Or if it is a commandline tool then you might put some example commands here:

$ python -m copier_example --version

TODO#

  • [x] Use pyright instead of mypy

  • [x] Use

  • [x] Use GH pages publishing

  • [x] Split up CI

  • [x] Slim down devcontainer

  • [x] Use dev constraints everywhere

  • [x] Investigate ruff checks and fixes

  • [x] Add pre-commit for dev constraints

  • [ ] Get docs from releases and add them too

  • [ ] MD-ify docs

  • [ ] Run repo review

  • [ ] Fix broken docs links

  • [ ] Group dependabot alerts

  • [ ] Delete favicon

  • [ ] Add copier to pyproject

How the documentation is structured#

The documentation is split into 2 sections:

The User Guide contains documentation on how to install and use copier-example.

The Developer Guide contains documentation on how to develop and contribute changes back to copier-example.