Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Update version references in tutorial: 0.1.0 -> 0.1 #279

Merged
merged 4 commits into from
May 23, 2024
Merged

Update version references in tutorial: 0.1.0 -> 0.1 #279

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
4fef3bc
update more mentions of 0.1.0 to 0.1
pb-413 May 21, 2024
e151ef7
change references to bumped version from 0.1.1 to 0.2
pb-413 May 21, 2024
7ee0da3
introduce patch rather than pump minor
pb-413 May 23, 2024
c254954
update version info in file names under example dist
pb-413 May 23, 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
14 changes: 7 additions & 7 deletions 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.0 /path/to/your/project/here/pyosPackage
pyosPackage 0.1 /path/to/your/project/here/pyosPackage
python-dateutil 2.8.2
pytz 2023.3.post1
six 1.16.0
Expand Down Expand Up @@ -160,9 +160,9 @@ To build your package run `hatch build`:
```bash
➜ hatch build
──────────────── sdist ─────────────────
dist/pyospackage-0.1.0.tar.gz
dist/pyospackage-0.1.tar.gz
──────────────── wheel ─────────────────
dist/pyospackage-0.1.0-py3-none-any.whl
dist/pyospackage-0.1-py3-none-any.whl

```

Expand All @@ -178,9 +178,9 @@ your package to conda-forge](publish-conda-forge). You will learn about this in
:::{todo}
➜ hatch build
────────────────────────────────────── sdist ──────────────────────────────────────
dist/pyospackage-0.1.0.tar.gz
dist/pyospackage-0.1.tar.gz
────────────────────────────────────── wheel ──────────────────────────────────────
dist/pyospackage-0.1.0-py3-none-any.whl
dist/pyospackage-0.1-py3-none-any.whl
:::

### <i class="fa-solid fa-wand-magic-sparkles"></i> Congratulations - you've created your Python package distribution files <i class="fa-solid fa-wand-magic-sparkles"></i>
Expand Down Expand Up @@ -269,8 +269,8 @@ TestPyPI.
❯ hatch publish -r test
Enter your username: __token__
Enter your credentials: <paste-your-token-value-here>
dist/pyospackage-0.1.0-py3-none-any.whl ... already exists
dist/pyospackage-0.1.0.tar.gz ... already exists
dist/pyospackage-0.1-py3-none-any.whl ... already exists
dist/pyospackage-0.1.tar.gz ... already exists

```

Expand Down
24 changes: 12 additions & 12 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.0"` or
- **statically** where you declare the version `version = "0.1"` 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.0"
version = "0.1"
```

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.0"
version = "0.1"
```

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

[project]
name = "pyospackage"
version = "0.1.0"
version = "0.1"
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.0"
version = "0.1"
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.0"
version = "0.1"
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.0"
version = "0.1"
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.0"
version = "0.1"
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.0"
version = "0.1"
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.0"
version = "0.1"
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.0" # manually assign version (not preferred)
version = "0.1" # 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.0` to `0.1.1`.
`0.1` to `0.1.1`.

```TOML
[build-system]
Expand Down
Loading