Skip to content

Commit 150e363

Browse files
Update project_publishing.md
1 parent d579f5e commit 150e363

File tree

1 file changed

+12
-1
lines changed

1 file changed

+12
-1
lines changed

episodes/project_publishing.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,15 @@ exercises: 15
2525
Once we have created our project, defined all the necessary metadata in the toml file, its time to publish our project. Let see the tools and steps we need to acheive this.
2626

2727
We need to install the following tools i.e. `build` and `twine`
28+
2829
## Create your build
29-
`build` :A tool to read the ['pyproject']toml file and build the package files
30+
31+
`build` :A tool to read the `pyproject.toml` file and build the package files
32+
3033
```bash
3134
pip install build
3235
```
36+
3337
```output
3438
Collecting build
3539
Downloading build-1.3.0-py3-none-any.whl.metadata (5.6 kB)
@@ -41,9 +45,11 @@ We need to install the following tools i.e. `build` and `twine`
4145
Installing collected packages: pyproject_hooks, build
4246
Successfully installed build-1.3.0 pyproject_hooks-1.2.0
4347
```
48+
4449
```bash
4550
python -m build
4651
```
52+
4753
```output
4854
* Creating isolated environment: venv+pip...
4955
* Installing packages in isolated environment:
@@ -58,6 +64,7 @@ We need to install the following tools i.e. `build` and `twine`
5864
* Building wheel...
5965
Successfully built greet_me-0.1.0.tar.gz and greet_me-0.1.0-py3-none-any.whl
6066
```
67+
6168
This command creates a `dist` directory containing two files:
6269
- A wheel file (`greet_me-0.1.0-py3-none-any.whl`).
6370
- A source archive (`greet_me-0.1.0.tar.gz`).
@@ -66,9 +73,12 @@ We need to install the following tools i.e. `build` and `twine`
6673

6774

6875
## Create an account on TestPyPI
76+
6977
Visit this [URL](https://test.pypi.org/account/register/) and crete an account to generate the API keys, to be able to upload your package to TestPyPI in the next step.
7078
Once you create your account, you can visit this [link](https://test.pypi.org/manage/account/token/) to generate the API key. Please copy the same in a notepad and paste it when prompted for it in the next step below.
79+
7180
<img width="1726" height="625" alt="image" src="https://github.com/user-attachments/assets/0c27a806-8fa2-469a-8b5c-fbf73c47e5e6" />
81+
7282

7383
## Upload your build
7484
`twine` :A tool for securely uploading packages to PyPI and TestPyPI.
@@ -127,6 +137,7 @@ https://test.pypi.org/project/po-greet-me/0.1.1/
127137
```
128138

129139
That's it! After the upload is successful, your package will be available on TestPyPI. E.g. : https://test.pypi.org/project/po-greet-me/0.1.1/
140+
130141
<img width="1619" height="854" alt="image" src="https://github.com/user-attachments/assets/980a83e1-dfce-4902-bb85-e44d47af9088" />
131142

132143
It is possible that the name of your project already exists or is simialr to an existing project. In that case you may end up in an error like this :

0 commit comments

Comments
 (0)