fbr 0.3.0

CLI scaffolding tool for structured project beginnings

Fabricator

Overview

Fabricator 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 fbr

Quickstart

fbr init

Optional Modules

Optional modules can be added with fbr add. For example, fbr 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

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

.
|-- .fabricator/
|   |-- 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 Fabricator metadata for the current project
• doctor
  • checks whether the current project has valid Fabricator metadata

Safety

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

Planned

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