https://github.com/billsioros/cookiecutter-pypackage-instance
An instance of cookiecutter-pypackage
https://github.com/billsioros/cookiecutter-pypackage-instance
Last synced: 7 months ago
JSON representation
An instance of cookiecutter-pypackage
- Host: GitHub
- URL: https://github.com/billsioros/cookiecutter-pypackage-instance
- Owner: billsioros
- License: mit
- Created: 2021-08-23T18:18:27.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2025-03-17T18:28:15.000Z (7 months ago)
- Last Synced: 2025-03-17T19:38:02.653Z (7 months ago)
- Language: Dockerfile
- Homepage: https://github.com/billsioros/cookiecutter-pypackage
- Size: 1 MB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: docs/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
Cookiecutter Pypackage Instance
🐍 An awesome python package by the name Cookiecutter Pypackage Instance
## :cd: Installation
```bash
pip install cookiecutter-pypackage-instance
```
In order to locally set up the project please follow the instructions below:
```shell
# 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
```
## :book: Documentation
The project's documentation can be found [here](https://billsioros.github.io/cookiecutter-pypackage-instance/).
## :heart: Support the project
Feel free to [**Buy me a coffee! ☕**](https://www.buymeacoffee.com/billsioros).
## :sparkles: Contributing
If you would like to contribute to the project, please go through the [Contributing Guidelines](https://billsioros.github.io/cookiecutter-pypackage-instance/latest/CONTRIBUTING/) first.
## :label: Credits
This project was generated with [`billsioros/cookiecutter-pypackage`](https://github.com/billsioros/cookiecutter-pypackage) cookiecutter template.