boilerplate-python/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

• Roadmap ➡️ project kanban
• Question, suggestion, issue ➡️ project issues
• Code submission ➡️ project merge request