Skip to content

Unique package name - Corrective action steps #280

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 31, 2024
Merged

Unique package name - Corrective action steps #280

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
63af4ff
first pass over steps from #244
pb-413 May 21, 2024
5c7e334
revert unrelated, unmerged changes
pb-413 May 21, 2024
4b7f1e9
fidle with markdown for better formatting / readability after build
pb-413 May 21, 2024
81ea657
Merge branch 'main' into unique-package-name
lwasser May 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
revert unrelated, unmerged changes
  • Loading branch information
@pb-413
pb-413 committed May 21, 2024
commit 5c7e33462f9f87326ab6ac3ce86345f9452b326a
2 changes: 1 addition & 1 deletion tutorials/publish-pypi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ Package Version Editable project location
numpy 1.26.3
pandas 2.1.4
pip 23.3.1
pyosPackage 0.1 /path/to/your/project/here/pyosPackage
pyosPackage 0.1.0 /path/to/your/project/here/pyosPackage
python-dateutil 2.8.2
pytz 2023.3.post1
six 1.16.0
Expand Down
26 changes: 13 additions & 13 deletions tutorials/pyproject-toml.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ The pyproject.toml file tells your build tool:

- What build backend to use to build your package (we are using `hatchling` in this tutorial but there are [many others to choose from](/package-structure-code/python-package-build-tools)).
- How and where to retrieve your package's version:
- **statically** where you declare the version `version = "0.1"` or
- **statically** where you declare the version `version = "0.1.0"` or
- **dynamically** where the tool looks to the most recent tag in your history to determine the current version.
- What dependencies your package needs
- What versions of Python your package supports (important for your users).
Expand Down Expand Up @@ -139,7 +139,7 @@ build-backend = "hatchling.build"

[project]
name = "pyospackage"
version = "0.1"
version = "0.1.0"
```

Your next step is to add additional recommended metadata fields that will both
Expand All @@ -161,7 +161,7 @@ After completing the [installable code tutorial](installable-code), you should h
```toml
[project]
name = "pyospackage"
version = "0.1"
version = "0.1.0"
```

Add the following to your table:
Expand Down Expand Up @@ -230,7 +230,7 @@ build-backend = "hatchling.build"

[project]
name = "pyospackage"
version = "0.1"
version = "0.1.0"
description = """
Tools that update the pyOpenSci contributor and review metadata
that is posted on our website
Expand Down Expand Up @@ -278,7 +278,7 @@ build-backend = "hatchling.build"

[project]
name = "pyospackage"
version = "0.1"
version = "0.1.0"
description = """
Tools that update the pyOpenSci contributor and review metadata
that is posted on our website
Expand Down Expand Up @@ -310,7 +310,7 @@ build-backend = "hatchling.build"

[project]
name = "pyospackage"
version = "0.1"
version = "0.1.0"
description = """
Tools that update the pyOpenSci contributor and review metadata
that is posted on our website
Expand Down Expand Up @@ -382,7 +382,7 @@ build-backend = "hatchling.build"

[project]
name = "pyospackage"
version = "0.1"
version = "0.1.0"
description = """
Tools that update the pyOpenSci contributor and review metadata
that is posted on our website
Expand Down Expand Up @@ -457,7 +457,7 @@ build-backend = "hatchling.build"

[project]
name = "pyospackage"
version = "0.1"
version = "0.1.0"
description = """
Tools that update the pyOpenSci contributor and review metadata
that is posted on our website
Expand Down Expand Up @@ -507,7 +507,7 @@ build-backend = "hatchling.build"

[project]
name = "pyospackage"
version = "0.1"
version = "0.1.0"
description = """
Tools that update the pyOpenSci contributor and review metadata
that is posted on our website
Expand Down Expand Up @@ -558,7 +558,7 @@ build-backend = "hatchling.build"

[project]
name = "pyospackage"
version = "0.1"
version = "0.1.0"
description = """
Tools that update the pyOpenSci contributor and review metadata
that is posted on our website
Expand Down Expand Up @@ -614,7 +614,7 @@ build-backend = "hatchling.build"
[project]
name = "pyospackage"
# dynamic = ["version"] # you will learn how to dynamically set the version in a future lesson
version = "0.1" # manually assign version (not preferred)
version = "0.1.0" # manually assign version (not preferred)
description = "Tools that update the pyOpenSci contributor and review metadata that is posted on our website"
authors = [{ name = "Firstname lastname", email = "email@pyopensci.org" }]

Expand Down Expand Up @@ -688,7 +688,7 @@ You are now ready to publish a new version of your Python package to (test) PyPI
Try to republish now.

First, update the version of your package in your pyproject toml file. Below version is updated from
`0.1` to `0.2`.
`0.1.0` to `0.1.1`.

```TOML
[build-system]
Expand All @@ -697,7 +697,7 @@ build-backend = "hatchling.build"

[project]
name = "pyospackage"
version = "0.2"
version = "0.1.1"
```

Now use hatch to publish the new version of your package to test.PyPI.org.
Expand Down