1HATCH-RELEASE(1) User Commands HATCH-RELEASE(1)
2
3
4
6 hatch release – Uploads to PyPI
7
9 hatch release [OPTIONS] [PACKAGE]
10
12 Uploads all files in a directory to PyPI using twine(1).
13
14 The path to the build directory is derived in the following order:
15
16 1. The optional argument, which should be the name of a package
17 that was installed via hatch install -l or pip install -e.
18
19 2. The --local flag.
20
21 3. The option --path, which can be a relative or absolute path.
22
23 4. The current directory. If the current directory has a dist
24 directory, that will be used instead.
25
26 If the path was derived from the optional package argument, the files
27 must be in a directory named dist.
28
29 The PyPI username can be saved in the config file entry pypi_username
30 or the TWINE_USERNAME environment variable. If the `TWINE_PASSWORD`
31 environment variable is not set, a hidden prompt will be provided for
32 the password.
33
35 -l, --local
36 Shortcut to select the only available local (editable) package.
37 If there are multiple, an error will be raised.
38
39 -p, --path TEXT
40 A relative or absolute path to a project.
41
42 -u, --username TEXT
43 The PyPI username to use.
44
45 -r, --repo TEXT
46 The PyPI repository to use (default:
47 ⟨https://upload.pypi.org/legacy/⟩). Should be a section in the
48 .pypirc file. (Can also be set via TWINE_REPOSITORY environment
49 variable)
50
51 -ru, --repo-url TEXT
52 The repository URL to upload the package to. This overrides
53 --repository. (Can also be set via TWINE_REPOSITORY_URL envi‐
54 ronment variable)
55
56 -t, --test
57 Uses the test version of PyPI. Equivalent to
58 -r https://test.pypi.org/legacy/
59
60 -s, --strict
61 Aborts if a distribution already exists. -h, --help Show a help
62 message and exit.
63
65 TWINE_USERNAME
66 PyPI username (or, use the pypi_username config file entry or
67 -u/--username)
68
69 TWINE_PASSWORD
70 PyPI password (or, use a hidden prompt)
71
72 TWINE_REPOSITORY
73 PyPI repository to use (or, use -r/--repo, -ru/--repo-url, or
74 the TWINE_REPOSITORY_URL environment variable)
75
76 TWINE_REPOSITORY_URL
77 PyPI repository URL to upload the package to (or, use
78 -ru/--repo-url, -r/--repo, or the TWINE_REPOSITORY environment
79 variable)
80
82 .pypirc
83 Should contain a section for the PyPI repository configured with
84 -r/--repo or with the TWINE_REPOSITORY environment variable.
85
87 twine(1)
88
89 hatch(1)
90
91 hatch-build(1), hatch-clean(1), hatch-conda(1), hatch-config(1),
92 hatch-env(1), hatch-grow(1), hatch-init(1), hatch-install(1),
93 hatch-new(1), hatch-pypath(1), hatch-python(1), hatch-shed(1),
94 hatch-shell(1), hatch-test(1), hatch-uninstall(1), hatch-update(1)
95
96
97
98 Feburary 2022 HATCH-RELEASE(1)