manati 0.2.0

A CLI for managing Python projects.

manati

A command line interface (CLI) for managing Python projects.

Create new Python projects with ready-to-go recommended project structure.

Add important files to existing projects like setup.py, .gitignore, Sphinx documentation, choose a license and more.

Run test suites, analyze test coverage and deploy to PyPi.

Installation

pip install --upgrade manati

Usage

Creating a project

manati create -n myproject

creates a complete Python project structure inside the current working directory:

myproject
├── docs
│   ├── Makefile
│   ├── conf.py
│   ├── index.rst
│   ├── make.bat
│   └── requirements.txt
├── myproject
│   ├── __init__.py
│   └── main.py
├── LICENSE
├── README.md
├── setup.py
├── .gitignore
└── tests
    └── test_main.py

including sample source, tests, documentation, setup.py, local git repository and a suitable .gitignore file.

After creation, the project is already installed in development (editable) mode, so you can start coding right away.

Adding stuff to an existing project

Sometimes you have an existing project, but initially you did not choose a license, or your .gitignore is missing. You can add those special files with the manati add command.

You can add

• setup.py file
• .gitignore file
• choose a license
• new packages
• docs folder with Sphinx documentation

Call manati add --help for more information.

Run tests and test coverage of existing project

To run the test suite of your existing project, run

manati run tests

To analyze the test coverage of your existing project, run

manati run coverage

For more information, run

manati run tests --help
manati run coverage --help

Deploy your project to PyPi

You can deploy your project to PyPi using manati:

manati deploy

As a prerequisite for deployment, you need an account at PyPi.

Documentation

The full documentation can be found here.

Requirements

All Python requirements are installed automatically. However, you need to have git installed.

Credits

Images by Natur Vektoren von Vecteezy.