Skip to content

Shortcut

psp has a three shortcut built-in: quick, simple and full.

Help

psp has a help to remember the usage and shortcut.

[gu]# psp help
psp (Python Scaffolding Projects), version 0.7.0
usage: psp [shortcut]
ie: psp [help|quick|simple|full]

shortcut:
    help:   print this help message
    quick:  enables a rapid setup (few options included)
    simple: enables a basic setup (only Python package)
    full:   enables a full setup (all options included)

links:
    repository:     https://github.com/MatteoGuadrini/psp
    documentation:  https://psp.readthedocs.io/

variables:
    []

environments:
    Python version: 3.14
[gu]# echo $?
0
[gu]# psp whatever
error: unknown shortcut command `whatever`
usage: psp [shortcut]
ie: psp [help|quick|simple|full]
[gu]# echo $?
1

Quick

The quick shortcut enables a rapid configuration of your Python project:

[gu]# psp quick
info: welcome to psp, version 0.7.0
> Name of Python project: mypyprj
> Select documentation generator: MKDocs
> Select license: MIT
Python project `mypyprj` created at mypyprj

The options included are:

Simple

The simple shortcut enables a basic configuration of your Python project:

[gu]# psp simple
info: welcome to psp, version 0.7.0
> Name of Python project: mypyprj
Python project `mypyprj` created at mypyprj

The options included are:

Full

The full shortcut enables a full configuration of your Python project:

[gu]# psp full
info: welcome to psp, version 0.7.0
> Name of Python project: mypyprj
> Select git remote provider: Github
> Username of Github: MatteoGuadrini
> Install dependencies: nosqlapi
> Select documention generator: MKDocs
> Select remote CI provider: TravisCI
> Select license: MIT
Python project `mypyprj` created at mypyprj

The options included are: