O generation of vipers, how can ye, being evil, speak good things?
- Matthew 12:34
genvi — A sadistic Python project wizard 🐍🧙
curl -fSL https://raw.githubusercontent.com/ruksi/genvi/main/magic/conjure.sh | bash
# and follow the instructionspython>=3.8, git and make.
"I would sacrifice anything for some good quality code." by Anonymous Principal Engineer 👩💻
genvi (generation of vipers 🐍) is a hyper-opinionated
tool for creating Python projects. It's strict, maybe too strict, borderline evil.
Each new project is configured with:
🐈⬛ eery ruff format as the code style, single quoted
🪝 sadistic pre-commit hooks to enforce conventions
🪄 automagical GitHub actions to verify incoming pull requests
🧙 bewitching testing setup with pytest with 100% coverage requirement
✴️ occult project management though make for development
🫴 plethora of style and type checkers included in ruff and mypy
"Who would want to manage a project like this?" by Anonymous Gnu 🐃
Scratching my own itch, see ABOUT.md to learn more
curl -fSL https://raw.githubusercontent.com/ruksi/genvi/main/magic/conjure.sh | bash-
Choose a combined project/package name
- Only use lowercase ASCII letters and numbers; nothing else
- This example uses
artproject
-
Clone this repository
git clone git@github.com:ruksi/genvi.git artproject cd artproject -
Run the wizard and follow instruction
python -m magic --name="artproject" --author="Arthur" --email="arthur@example.com"
This project is released under the MIT License.
Sure, the README template should get you started
as genvi itself works like the projects it generates.