(C) 2022 - 2023, Dmitrii Gusev
Use this repository as template for python projects. Ideal for various utilities/libraries. For the web-projects this template should be adjusted a bit more or use Django web-site/project generation utility.
This repository uses python version: 3.11
- [docker] - folder with Docker files for various DBs
- docker-compose-mssql.yml - dockerised MS SQL Express DBMS
- docker-compose-mysql.yml - dockerised MySql DBMS
- docker-compose-postgres.yml - dockerised Postgresql DBMS
- [docs] - project documantation catalog
- [jupyter] - jupyter playbooks catalog
- [tests] - unit/integration tests catalog
- .coveragerc - settings file for pytest coverage module
- .gitattributes - parameters for the GIT repository (line endings, auto conversions, etc.)
- .gitignore - GIT repository ignoring files
- .pre-commit-config.yaml - TBD
- build.sh - TBD
- env_python_setup.sh - shell script for the system python environment setup/reset
- env_virtual_setup.sh - shell script for the pipenv virtual environment setup/reset
- LICENSE - application/module license
- Pipfile - pipenv configuration file
- pytest.ini - pytest module additional setup parameters
- README.md - this documentation file
- setup.cfg - main configuration file for the project + setuptools
- setup.py - dummy setup file for setuptools, necessary meta-information moved to setup.cfg
Adjust this template as necessary. If you don't need any files - remove them after creating your repository from this template.
Review the content and adjust as needed. Here are some advice, what may be useful:
- [docker] - use docker files as needed
- .gitignore** - file should cover most of the cases for python project, but some adjustments may be required
- build.sh - TBD
- env_virtual_setup.sh - TBD
- Pipfile - TBD
- README.md - definitely, you will write your own documentation :)
- setup.cfg - TBD
In order to install the current package/source code locally, add the following line to the Pipfile in the section [packages]:
<your_package_name> = {editable = true, path = "."}