fcode/boilerplate-python
fcode/boilerplate-python
Template
2
0
Fork 0
Code Issues Pull requests Projects Releases Activity
Un modèle de script autoportant orienté bonnes pratiques 🐍 ✨
8 commits 4 branches 2 tags 49 KiB
  • Python 75.2%
  • Makefile 24.8%
Find a file Use this template
Exact
Freezed b28a33345a 🔀 Add a basic logger to the template 
Do not use `print()` anymore in the script to print stuff on STDOUT,
use `logger.info()` instead.

If script is run in crontab, it loggs to syslog.
2022-10-26 00:42:54 +02:00
.gitlab-ci.yml 👷 Add CI for GitLab 2022-10-25 00:44:23 +02:00
LICENSE.md 🎉 Initial commit 2022-04-27 16:03:43 +02:00
main.py 🔀 Add a basic logger to the template 2022-10-26 00:42:54 +02:00
Makefile 👷 Add CI for GitLab 2022-10-25 00:44:23 +02:00
pyproject.toml ✨ Add a python standalone template & tools 2022-10-25 00:34:34 +02:00
README.md ✨ Add a python standalone template & tools 2022-10-25 00:34:34 +02:00
requirements-dev.txt ✨ Add a python standalone template & tools 2022-10-25 00:34:34 +02:00

README.md

Python Boilerplate

Stuff used for a new python project 🐍

💡 Idea

  1. Keep in mind the Standalone Python script proposed by Vincent Bernat ( 🇫🇷 | 🇬🇧 ).
  2. Ease new project start
  3. Give a try to the GitLab group organisation

🚀 Use quick-start

Get the source & edit settings:

git clone git@<GIT REPO URL>:<GIT REPO PATH>.git && cd <GIT REPO NAME>
cp client.sample.py client.py
${EDITOR} client.py

Set up environment & run help:

mkdir ~/.venvs && python3 -m venv ~/.venvs/<GIT REPO NAME>
source ~/.venvs/<GIT REPO NAME>/bin/activate
pip install -r requirements.txt
./main.py -h

🚧 Development

🚀 Quick-start

  • Built with Python 3.8
  • Code linting with flake8, pylint, black & pydocstyle.
  • Install development tools:
    • pip install -r requirements-dev.txt
  • A Makefile with tools : run make help to have a look
  • Use the pre-commit git hook
    • make init-pre-commit

📌 Dependences

Details in requirements.txt & requirements-dev.txt

🤝 Contributing