https://github.com/m4tice/py-prj-tmpl
Empty Python project template with custom workflow
https://github.com/m4tice/py-prj-tmpl
ci continuous-integration continuous-testing github-actions project-template-repo pylint pytest
Last synced: 6 days ago
JSON representation
Empty Python project template with custom workflow
- Host: GitHub
- URL: https://github.com/m4tice/py-prj-tmpl
- Owner: m4tice
- Created: 2023-09-01T04:01:52.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-03-23T02:10:54.000Z (about 1 year ago)
- Last Synced: 2025-10-26T14:42:38.211Z (7 months ago)
- Topics: ci, continuous-integration, continuous-testing, github-actions, project-template-repo, pylint, pytest
- Language: Python
- Homepage:
- Size: 35.2 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Introduction
This Git repo serves as a template for a newly started Python Project.
Outline:
* Git commit message
* Environment handling
* Project structure management
* Pytest
* SQL Database handling
* Web Development
* Pylint
**1. Git commit message**
Please start the commit message with the following tags:
* Create new file
```
create:
```
* Add new code
```
add:
```
* Update file / code
```
update:
```
* Remove file / code
```
remove:
```
**2. Environment handling**
* Command to create new python virtual environment
```
python -m venv
```
* Command to activate created virtual environment
```
.venv\Scripts\activate.bat
```
* Command to install libraries listed in requirements.txt
```
pip install -r requirements.txt
```
* Command to export existing libraries to requirements.txt
```
pip freeze > requirements.txt
```
**3. Project structure management**
Run init_structure.bat to create the desire project structure.
**4. Pytest**
Command to run pytest
```
pytest -vv
```
**5. SQL Database handling**
Reference: [m4tice-python-sqlite3](https://github.com/m4tice/python-sqlite3)
**6. Web Development**
Command to run flask application
```
flask run
```
or in debug mode
```
flask run --debug
```
Command to run fastapi application
with fastapi[standard]
```
fastapi dev main.py
```
or
```
uvicorn main:app --reload
```
**7. Pylint**
Github's commitment to this project is managed with Pylint.
Pylint warnings will prevent the commit until all the warnings are resolved.
In case you cannot resolve the warning, leave the following comment at the end of the same line
# pylint: disable=, , etc.
For example:
* Pylint warning:
```
Line too long (145/100) Pylint(C0301:line-too-long)
```
* To disable it:
```
# pylint: disable=line-too-long
```
In case you want to disable pylint check with the whole file, put the following comment at the beginning of the *.py module:
* Pylint < 0.25:
```
# pylint: disable-all
```
* Pylint 0.26.1 ->:
```
# pylint: skip-file
```
You might not like it, but that's my preference to keep things in place ;)