putup(1) - f37

1PUTUP(1)                         User Commands                        PUTUP(1)
2
3
4

NAME

6       putup – PyScaffold command-line interface
7

SYNOPSIS

9       putup  [-h] [-n NAME] [-p PACKAGE_NAME] [-d TEXT] [-l LICENSE] [-u URL]
10       [-f] [-U] [-V] [-v]  [-vv]  [-P]  [--list-actions]  [--cirrus]  [--con‐
11       fig CONFIG_FILE [CONFIG_FILE ...] | --no-config]           [--save-con‐
12       fig [SAVE_CONFIG]]   [--github-actions]   [-gitlab]    [-i]    [--name‐
13       space NS1[.NS2]]     [--no-pyproject]     [--no-skeleton]    [--no-tox]
14       [--pre-commit]  [--venv [VENV]]  [--venv-install PACKAGE [PACKAGE ...]]
15       PROJECT_PATH
16

DESCRIPTION

18       PyScaffold  is  a  tool  for easily putting up the scaffold of a Python
19       project.
20

OPTIONS

22   POSITIONAL ARGUMENTS
23       PROJECT_PATH
24              path where to generate/update project
25
26   OPTIONAL ARGUMENTS
27       -h, --help
28              show a help message and exit
29
30       -n NAME, --name NAME
31              installable name (as in pip install/PyPI, default:  basename  of
32              PROJECT_PATH)
33
34       -p PACKAGE_NAME, --package PACKAGE_NAME
35              package name (as in import, default: NAME)
36
37       -d TEXT, --description TEXT
38              package description
39
40       -l LICENSE, --license LICENSE
41              package  license  like  MIT,  AGPL-3.0-or-later,  AGPL-3.0-only,
42              Apache-2.0,  Artistic-2.0,  0BSD,  BSD-2-Clause,   BSD-3-Clause,
43              CC0-1.0,      EPL-1.0,      GPL-2.0-or-later,      GPL-2.0-only,
44              GPL-3.0-or-later,    GPL-3.0-only,    ISC,    LGPL-2.0-or-later,
45              LGPL-2.0-only,  LGPL-3.0-or-later, LGPL-3.0-only, MPL-2.0, Unli‐
46              cense, Proprietary (default: MIT)
47
48       -u URL, --url URL
49              main website/reference URL for package
50
51       -f, --force
52              force overwriting an existing directory
53
54       -U, --update
55              update an existing project by replacing the most important files
56              like  setup.py  etc.   Use  additionally  --force to replace all
57              scaffold files.
58
59       -V, --version
60              show program’s version number and exit
61
62       -v, --verbose
63              show additional information about current actions
64
65       -vv, --very-verbose
66              show all available information about current actions
67
68       -P, --pretend
69              do not create project, but displays the log of all operations as
70              if it had been created
71
72       --list-actions
73              do not create project, but show a list of planned actions
74
75       --cirrus
76              add  configuration  file  for Cirrus CI ⟨https://cirrus-ci.org/⟩
77              (includes --pre-commit)
78
79       --config CONFIG_FILE [CONFIG_FILE ...]
80              config file to read PyScaffold’s preferences (see --help  output
81              for default)
82
83       --no-config
84              prevent PyScaffold from reading its default config file
85
86       --save-config [SAVE_CONFIG]
87              save  the  given options in a config file (see --help output for
88              default)
89
90       --github-actions
91              add     configuration     file      for      GitHub      Actions
92              ⟨https://github.com/features/actions⟩ (includes --pre-commit)
93
94       --gitlab
95              generate  GitLab  CI ⟨https://docs.gitlab.com/ee/ci/⟩ configura‐
96              tion files
97
98       -i, --interactive
99              interactively choose and configure PyScaffold’s parameters
100
101       --namespace NS1[.NS2]
102              put your project inside a namespace  package  (default:  use  no
103              namespace)
104
105       --no-pyproject
106              do  not  include  a pyproject.toml file in the project root, and
107              thus   avoid   isolated   builds   as    defined    in    PEP517
108              ⟨https://peps.python.org/pep-0517/⟩             /            518
109              ⟨https://peps.python.org/pep-0518/⟩ [not recommended]
110
111       --no-skeleton
112              omit creation of skeleton.py and test_skeleton.py
113
114       --no-tox
115              prevent a tox configuration file from being created
116
117       --pre-commit
118              generate pre-commit configuration file
119
120       --venv [VENV]
121              create a virtual environment for the project  (using  virtualenv
122              or stdlib’s venv).  Default location: “.venv”.  If virtualenv is
123              available, it will be used, since it has  some  advantages  over
124              stdlib’s     venv     (such     as     being     faster,     see
125              ⟨https://virtualenv.pypa.io/en/stable/⟩).  Notice that  even  if
126              part of Python’s stdlib, venv is not guaranteed to be installed;
127              some OS/distributions (such as Ubuntu) require an  explicit  in‐
128              stallation.   If  you  have  problems, try installing virtualenv
129              with pip(1) and run the command again.
130
131       --venv-install PACKAGE [PACKAGE ...]
132              install packages inside the created venv.  The packages can have
133              dependency  ranges  as  if  they  would be written to a require‐
134              ments.txt file, but remember to use quotes to avoid messing with
135              the terminal
136

NAME

SYNOPSIS

DESCRIPTION

OPTIONS

SEE ALSO