Welcome to pmpy!

pmpy (Project Manager Python) is a simple CLI tool for managing projects.

Available commands

build_docs

Compiles the command documentation.

usage: pmpy build_docs [-h] output

positional arguments:
  output      Output destination

optional arguments:
  -h, --help  show this help message and exit

create_config

Creates a new configuration.

usage: pmpy create_config [-h] project

positional arguments:
  project     Project to create the config for.

optional arguments:
  -h, --help  show this help message and exit

create_env

Loads a project environment.

usage: pmpy create_env [-h] project

positional arguments:
  project     Name of the project

optional arguments:
  -h, --help  show this help message and exit

create_project

Creates a new project at the given destination x in the projects directory.

usage: pmpy create_project [-h] [-d] [-f] [-r REPO] [-o] [--no-env]
                           [--clone CLONE]
                           project

positional arguments:
  project               Name of the project

optional arguments:
  -h, --help            show this help message and exit
  -d, --delete          Delete project if already exists.
  -f, --force           Force deletion of the project.
  -r REPO, --repo REPO  Repository to clone.
  -o, --open            Automatically run the open_project command.
  --no-env              Do not create an environment.
  --clone CLONE         Command to use for cloning.

git_pep8_compliance

Generates a report on the given project for PEP8 compliance.

Uses git blame for determining who committed the violation.

usage: pmpy git_pep8_compliance [-h] [--pep8-options PEP8_OPTIONS]
                                [--blame-options BLAME_OPTIONS]
                                [--output {csv,json}]
                                project

positional arguments:
  project               Name of the project

optional arguments:
  -h, --help            show this help message and exit
  --pep8-options PEP8_OPTIONS
                        pep8 options.
  --blame-options BLAME_OPTIONS
                        git blame options.
  --output {csv,json}   Output format.

load_env

Loads a project environment.

usage: pmpy load_env [-h] project

positional arguments:
  project     Name of the project

optional arguments:
  -h, --help  show this help message and exit

open_project

Opens a project activating the environment and opening using the
configured editor.
usage: pmpy open_project [-h] [--no-editor] [--no-load] project

positional arguments:
  project      Name of the project

optional arguments:
  -h, --help   show this help message and exit
  --no-editor  Do not open the project in the editor
  --no-load    Do not load the project environment

show_config

Dumps the configuration. If given a project it will dump that projects
configuration.
usage: pmpy show_config [-h] [project] [section]

positional arguments:
  project     Optional name of project to show.
  section     Optional section to show.

optional arguments:
  -h, --help  show this help message and exit