Skip to content

Commit 63af4ff

Browse files
committed
first pass over steps from #244
1 parent e151ef7 commit 63af4ff

File tree

1 file changed

+21
-5
lines changed

1 file changed

+21
-5
lines changed

tutorials/publish-pypi.md

Lines changed: 21 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -205,11 +205,27 @@ If you have a package that you are confident belongs on PyPI, all of the steps b
205205

206206
Example: `pyosPackage_yourNameHere`.
207207

208-
:::{todo}
209-
Show them how to do this
210-
211-
1. update the project-name in the pyproject.toml file
212-
2. update the module repository directory to be the same
208+
:::{dropdown} Renaming your project before publishing
209+
:color: secondary
210+
211+
**Required**:
212+
0. Search your publishing location(s) to make sure your new name isn't taken
213+
- [TestPyPI](https://test.pypi.org/)
214+
- [PyPI](https://pypi.org/)
215+
- [conda-forge](https://conda-forge.org/packages/)
216+
1. Update the project name in your pyproject.toml file
217+
- `name = "pyospackage_yourNameHere"`
218+
2. Update the module folder name to be the same
219+
- `src/pyospackage_yourNameHere`
220+
3. Rebuild your project
221+
- `hatch build`
222+
4. Publish your package to capture the name (continue this guide!)
223+
224+
**Recommended**:
225+
- Update the Github repository name to align with the new package name
226+
- Update the project folder to match the new package name
227+
- `pyospackage_yourNameHere/src`
228+
- Update mentions of your repository name in other files; e.g. `README.md`
213229
:::
214230

215231
:::{figure-md} test-pypi-search

0 commit comments

Comments
 (0)