Skip to content

Commit 2aedaf6

Browse files
committed
Rewording
1 parent 8b609c6 commit 2aedaf6

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

03_building_and_packaging/pypi_exercise.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,14 @@
22

33
## Starting remarks
44

5-
- [Exercise repository link](https://github.com/Simulation-Software-Engineering/diffusion2D)
5+
- [Exercise repository link](https://github.com/Simulation-Software-Engineering/diffusion2d)
66
- Deadline for submitting this exercise is **Wednesday 19th November 09:00**.
77
- The code in this exercise produces plots and in order to view them you need to use a GUI-based operating system or environment.
8+
- The exercise follows the steps in the [Python packaging tutorial](https://packaging.python.org/en/latest/tutorials/packaging-projects/).
89

910
## Brief idea of the exercise
1011

11-
In this exercise you will convert a raw Python code into a packaged code which is uploaded to the testing index of PyPI called [TestPyPI](https://test.pypi.org/). You may find such exercises online, for example, [the tutorial on python.org](https://packaging.python.org/tutorials/packaging-projects/), but in this exercise we will attempt to package a simulation code. After preparing the code we will create build artifacts and upload them to the package index.
12+
In this exercise you will convert a Python code into a package that is on [TestPyPI](https://test.pypi.org/). The code is a simple simulation code. After preparing the code for packaging, you will create build artifacts and upload them to the package index.
1213

1314
## Prerequisites
1415

@@ -25,7 +26,7 @@ In this exercise you will convert a raw Python code into a packaged code which i
2526
## Step 1 - Acquiring the code and getting familiar with it
2627

2728
- Fork the [exercise repository](https://github.com/Simulation-Software-Engineering/diffusion2D).
28-
- Open the file `diffusion2d.py` and go through the file and try to understand the code components.
29+
- Open the file `diffusion2d.py` and go through the file and try to understand it.
2930
- Check if your system has Python version >= 3.6 and update it if it is older than 3.6.
3031
- Install pip, build, and twine.
3132
- Install NumPy and Matplotlib with `pip`. The installation instructions can be found on the webpages (links in the Prerequisites section of this document).
@@ -92,8 +93,8 @@ diffusion2d.solve()
9293

9394
## Step 7 - Testing the deployed package
9495

95-
- Using the commands from the lecture notes try to install the package using `pip` and also run the code by importing the `solve()` functionality in a Python script or an interactive Python shell.
96-
- Even though your package is on TestPyPI, the dependencies of the package need to be installed from PyPI. To make sure that the dependencies are installed from PyPI and not TestPyPI, use the `--extra-index-url` flag in the `pip` command appropriately.
96+
- Try to install the package using `pip` and also run the code by importing the `solve()` functionality in a Python script or an interactive Python shell.
97+
- Even though your package is on TestPyPI, the dependencies of the package need to be installed from PyPI. To make sure that the dependencies are installed from PyPI and not TestPyPI, use the `--extra-index-url` option of `pip`.
9798

9899
## Step 8 - Submitting the exercise
99100

0 commit comments

Comments
 (0)