psycho 2.1.0

A tool to manage python projects and their dependencies.

Let's go psycho!

Python project management automation using standard build tools.

Status

This project is a working prototype.

This package is available from pypi, but the best way to install it is with pipx.

pipx install psycho

Overview

Python projects are migrating away from using setup.py to pyproject.toml. While a number of excellent projects provide custom tooling, there is no built in support for automating project management with just the standard tools:

• setuptools
• pip
• build
• twine

Psychotic Commands

The following are supported.

• init
• install
• uninstall
• build
• upload
• publish

init

Makes a new pyproject.toml. The command prompts for input.

$ psycho init
Name: my-package
Version [0.1.0]: 
Description: My package
Author: rob
Email: [e-mail]
Initializing my-package

Alternatively values can be provided as arguments.

$ psycho init \
    --name my-package \
    --version 0.1.0 \
    --description "My package" \
    --author "Rob Blackbourn" \
    --email "[e-mail]"

Or by passing -y to accept the defaults.

$ psycho init -y

This creates the standard project structure, with a local virtual environment. It will also upgrade pip and install the project in the virtual environment.

The following flags are also supported:

• --no-venv to not create a virtual environment.
• --no-tests to not create the tests folder.
• --no-upgrade to prevent the venv dependencies being upgraded (pip).
• --venv <venv-name> to give the venv folder a specific name (the default is ".venv").

install

When used without specifying packages this command installs the project as editable.

$ psycho install

This is the equivalent of pip install --editable ..

When used with a package requirement, the requirement is written to the pyproject.toml and the package is installed into the python environment using pip.

$ psycho install "pandas>=1.5.3"

The -optional flag can be used (with a group name) to add an optional dependency.

$ psycho install --optional dev pytest

Most the flags used by pip are available to this command.

uninstall

This command removes a package from the pyproject.toml file, and uninstalls it using pip.

$ psycho uninstall pandas

This can be used with the optional flag (with a group name) to uninstall an optional dependency.

$ psycho uninstall --optional dev pytest

build

The build command will build a package, prior to publishing it.

$ psycho build

This is the equivalent of python -m build.

upload

The upload command will upload a package with twine.

$ psycho upload

This is the equivalent of twine upload dist/*.

publish

This combines the build and publish in one command.

$ psycho publish