Skip to content

init

Create initial project structure. Files created: pyproject.toml, README.md, .gitignore, src/<NAME>/__init__.py

Arguments

  • path: Where to place the project (defaults to current path)

Options

  • --name <NAME>: Project name (defaults to current path basename)
  • --description <DESCRIPTION>: Project description
  • -t, --type: Project type, can be either lib, app or script (defaults to lib)
  • -T,--template: Path to a copier template, can be a local path or an URL (defaults to gh:Jahn16/pspm-template)

Examples

Initialize project in the current directory:

~/codes/banana

spm init # Project name will be set to banana

Initialize project to another directory:

~/codes

spm init apple # Creates directory apple and sets the project name to apple