https://github.com/vladpunko/python-template
Standardized template for new python projects
https://github.com/vladpunko/python-template
python python-project-template python-template python3
Last synced: about 2 months ago
JSON representation
Standardized template for new python projects
- Host: GitHub
- URL: https://github.com/vladpunko/python-template
- Owner: vladpunko
- License: mit
- Created: 2025-02-02T19:49:09.000Z (11 months ago)
- Default Branch: master
- Last Pushed: 2025-02-11T20:16:26.000Z (11 months ago)
- Last Synced: 2025-02-11T21:23:35.985Z (11 months ago)
- Topics: python, python-project-template, python-template, python3
- Language: Python
- Homepage:
- Size: 314 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# {{PROJECT_NAME}}
{{BADGES}}
{{DESCRIPTION}}
{{IMAGE_PREVIEW}}
## Installation
It is recommended to use this package together with [virtualenv](https://github.com/pypa/virtualenv) and [virtualenvwrapper](https://github.com/python-virtualenvwrapper/virtualenvwrapper) to work with python virtual environments more suitable. Make sure the installed [python](https://wiki.archlinux.org/title/python) interpreters work without errors on the current operating system. To install this package you are to use the [pip](https://pip.pypa.io/en/stable) package manager by running the following command:
```bash
python3 -m pip install {{PROJECT_NAME}}
```
You can also install this python package on your working machine from source code:
```bash
# Step -- 1.
git clone --depth=1 --branch=master {{GIT_REPOSITORY_URL}}
# Step -- 2.
cd ./{{PROJECT_NAME}}/
# Step -- 3.
echo 'All the required steps.'
```
## Basic Usage
{{USAGE_DESCRIPTION}}
```bash
echo 'Usage examples.'
```
## Contributing
Pull requests are welcome.
Please open an issue first to discuss what should be changed.
Please make sure to update tests as appropriate.
```bash
# Step -- 1.
python3 -m venv .venv && source ./.venv/bin/activate && pip install pre-commit tox
# Step -- 2.
make hooks
# Step -- 3.
make tests && make lint
```
## License
[MIT](https://choosealicense.com/licenses/mit)