Cookiecutter Pypackage Instance

🐍 An awesome python package by the name Cookiecutter Pypackage Instance

💿 Installation

pip install cookiecutter-pypackage-instance

In order to locally set up the project please follow the instructions below:

# Set up the GitHub repository
git init
git config --local user.name Vasilis Sioros
git config --local user.email billsioros97@gmail.com
git add .
git commit -m "feat: initial commit"
git remote add origin https://github.com/billsioros/cookiecutter-pypackage-instance

# Create a virtual environment using poetry and install the required dependencies
poetry shell
poetry install

# Install pre-commit hooks
pre-commit install --install-hooks
pre-commit autoupdate

📖 Documentation

The project's documentation can be found here.

❤️ Support the project

Feel free to Buy me a coffee! ☕.

✨ Contributing

If you would like to contribute to the project, please go through the Contributing Guidelines first.

🏷️ Credits

This project was generated with billsioros/cookiecutter-pypackage cookiecutter template.