envoker 0.3.0

CLI scaffolding tool for structured project beginnings

ENVoker

Overview

ENVoker is a CLI tool for starting small Python projects without the need to repeat the same setup steps every time. It creates files and folders to use as a starter structure. It also contains optional helper modules that can be added individually. The boring setup work is handled and you can start building more quickly.

Install

pip install envoker

Quickstart

envoke init

Optional Modules

Optional modules can be added with envoke add. For example, envoke add csv adds a small csv helper module for reading and writing csv files. See Commands below for the full command list.

What It Creates

envoke init adds a small starter structure to the current folder:

.
|-- .envoker/
|   |-- project.toml
|-- src/
|   |-- main.py
|-- .env.example
|-- .gitignore
|-- README.md
|-- requirements.txt

Commands

• init
  • adds the starter project structure to the current folder
• list
  • shows available templates
• modules
  • shows available helper modules
• add
  • adds one helper module to utils/
• info
  • shows ENVoker metadata for the current project
• doctor
  • checks whether the current project has valid ENVoker metadata

Safety

No overwrite by default. --dry-run previews. --force is explicit.

Planned

ENVoker is expected to grow by including custom environment examples and custom modules for more personalization.