copydocs

DRY: Reuse your docstrings.

Installation

If you want to…

…use this tool in your project 💻

You might simply install it with pip:

pip install copydocs

If you use Poetry, then run:

poetry add copydocs

…contribute to copydocs 🚀

[!Note] If you use Windows, it is highly recommended to complete the installation in the way presented below through WSL2.

1. Fork the copydocs repository on GitHub.

2. Install Poetry.
   Poetry is an amazing tool for managing dependencies & virtual environments, building packages and publishing them.

   pipx install poetry
   

   _{If you encounter any problems, refer to the official documentation for the most up-to-date installation instructions.}

   Be sure to have Python 3.8 installed—if you use pyenv, simply run:

   pyenv install 3.8
   

3. Clone your fork locally and install dependencies.

   git clone https://github.com/your-username/copydocs path/to/copydocs
   cd path/to/copydocs
   poetry env use $(cat .python-version)
   poetry install
   poetry shell
   pre-commit install --hook-type pre-commit --hook-type pre-push
   

For more information on how to contribute, check out CONTRIBUTING.md.
Always happy to accept contributions! ❤️

Legal info

© Copyright by Bartosz Sławecki (@bswck).
This software is licensed under the MIT License.