Further reworking of slides and slimming down the demo

Author: IshaanDesai

03_building_and_packaging/pip_demo.md

@@ -73,11 +73,3 @@ pip show nutils
 ```bash
 python -m pip install package-name
 ```
-
-## 4. How to read a PEP
-
-- Have a look at [PEP 8](https://peps.python.org/pep-0008/)
-
-## 5. Understanding a PyPI package webpage
-
-- Having a look at [fenicsprecice](https://pypi.org/project/fenicsprecice/)

03_building_and_packaging/pypi_slides.md

@@ -72,7 +72,7 @@ In this lecture, we work with pip, because ...
 - PEP is an evolving design document which provides information regarding new features, processes and new environments.
 - PEPs typically involve concise technical information, which also acts as standardizations.
 - Packaging is standardized by [Packaging PEPs](https://peps.python.org/topic/packaging/).
-- Example of a Packaging PEP: 
+- Example of a Packaging PEP: [PEP 427 – The Wheel Binary Package Format 1.0](https://peps.python.org/pep-0427/).
 
 ---
 
@@ -82,6 +82,7 @@ Distribution package
 
 - Something you can install.
 - `pip install pkg`.
+- Directly acquired from a packaging index.
 
 Import package
 
@@ -104,43 +105,49 @@ Read more about [distribution package vs. import package](https://packaging.pyth
 
 ---
 
-## Create the source tree 1/2
+## Create the source tree 1/3
 
-Four places where naming is relevant:
+Source tree of code:
 
-- Name of the repository (on GitHub or GitLab).
-- Name of the folder which has the source code.
-- Name of the package as seen by PyPI.
-- Name of the package to be used in the `import` statement.
+```bash
+application/
+├── source.py
+├── tests/
+```
 
-**All names are independent of each other.**
+`source.py` contains the code. It can be multiple files.
 
-Example folder structure:
+---
+
+## Create the source tree 2/3
+
+Once the file structuring is complete, the source tree is:
 
 ```bash
-generic_folder_name/
-- src/
-  - __init__.py
-  - source-code.py
+application/
+├── LICENSE
+├── README.md
+├── pyproject.toml
+├── package_name/
+|   ├── __init__.py
+|   ├── source.py
+└── tests/
 ```
 
-- The file `__init__.py` is required to import the `package_name/` as a package. This file is mostly empty
-- `source-code.py` contains the code. It can be multiple files.
+- The file `__init__.py` is required to import the directory `package_name/` as a package.
 
 ---
 
-## Create the source tree 2/2
+## Create the source tree 3/3
 
-- Once the file structuring is complete, the source tree is:
+Four places where naming is relevant:
 
-```bash
-generic_folder_name/
-- pyproject.toml
-- src/
-  - __init__.py
-  - source-code.py
-  - tests/
-```
+- Name of the repository (on GitHub or GitLab).
+- Name of the folder which has the source code.
+- Name of the distribution package.
+- Name of the import package.
+
+**All names are independent of each other, but try to have one name.**
 
 ---
 
@@ -192,6 +199,8 @@ Read more in [is setup.py deprecated?](https://packaging.python.org/en/latest/di
 
 Source distribution (sdist) vs. built distribution (wheel)
 
+Base command is `python3 -m build`.
+
 ---
 
 ## Create Build Artifacts 2/3
@@ -310,7 +319,9 @@ List packages by running
 pip freeze
 ```
 
-or
+also useful to generate `requirements.txt`: `pip freeze > requirements.txt`.
+
+Additionally what works is
 
 ```bash
 pipx list
@@ -320,7 +331,7 @@ pipx list
 
 ## PyPI
 
-- [PyPI](https://pypi.org/) = **Python Package Index** is a repository of software developed in the Python community.
+- [PyPI](https://pypi.org/) = **Python Package Index** is an online index of Python packages.
 - PyPI itself is developed on GitHub through another software called [Warehouse](https://github.com/pypa/warehouse).
 - PyPI has an informative [public dashboard](https://p.datadoghq.com/sb/7dc8b3250-85dcf667bd) to show its activity.
 - A major advantage is the active maintenance of PyPI and the packages indexed in it.
@@ -356,10 +367,9 @@ pip install --index-url https://test.pypi.org/simple/ <package-name>
 
 ## Important takeaways
 
-Packaging of Python code is
-
-- creation of a standardized folder structure to convert raw Python code into a project.
-- creating and uploading distribution archives.
-- Uploading distribution archives to a package index.
+Packaging of Python code consists of ...
 
-We saw the process of packaging and uploading to TestPyPI which is similar to uploading to the PyPI.
+- ... creating a standardized folder structure to convert raw Python code into a project.
+- ... creating build artifacts.
+- ... uploading build artifacts to a package index.
+- ... testing if the uploaded package can be installed.