Merge pull request #3 from da5nsy/main

more edits!

Author: priya-gitTest

episodes/4_project_metadata.md

@@ -38,14 +38,15 @@ It has two main keys:
 requires = ["hatchling"] 
 build-backend = "hatchling.build"
 ```
-Some other build tools to read are 
-- [pdm.backend](https://backend.pdm-project.org) e.g. [fastapi](https://github.com/fastapi/fastapi/blob/master/pyproject.toml)
-- [mesonpy](https://mesonbuild.com/meson-python/) e.g. [numpy](https://github.com/numpy/numpy/blob/main/pyproject.toml)
-- [setuptools.build_meta]() e.g. [parselmouth](https://github.com/prefix-dev/parselmouth/blob/main/pyproject.toml)
+Some other build tools to read are:
+ 
+- [pdm.backend](https://backend.pdm-project.org) e.g. [fastapi](https://github.com/fastapi/fastapi/blob/cd40c5b40ffd8ba0c6a6a6c96bbf34ec1cf9c525/pyproject.toml#L2)
+- [mesonpy](https://mesonbuild.com/meson-python/) e.g. [numpy](https://github.com/numpy/numpy/blob/1d053b3482b178ed057474402ae94c80701796e0/pyproject.toml#L2)
+- [setuptools.build_meta](https://setuptools.pypa.io/en/latest/build_meta.html) e.g. [parselmouth](https://github.com/prefix-dev/parselmouth/blob/eb3eda68672ba95871719866403318690e1b37be/pyproject.toml#L3)
 
 ## Editable Installation
 
-Projects may be installed in editable mode, which allows you to make changes to the source code and have them reflected immediately in the environment without reinstallation. For example, the `greet_me` package can be added as an editable dependency.
+Projects may be installed in editable mode, which allows you to make changes to the source code and have them reflected immediately in the environment without reinstallation. For example, the `greet_me` package we are creating is listed as editable by default.
 
 ```toml
 [tool.pixi.pypi-dependencies]
@@ -58,8 +59,9 @@ greet_me = { path = ".", editable = true }
 requires-python = ">=3.11, <3.12"
 ```
 Additional sections in `pyproject.toml` may include:
-  `[tool.pixi.workspace]`: Defines project-wide settings, including package sources and target platforms for resolution.  
-  `[tool.pixi.pypi-dependencies]` : Declares the dependencies to be installed from PyPI (or equivalent sources). These are the external libraries required by the project.
+
+-  `[tool.pixi.workspace]`: Defines project-wide settings, including package sources and target platforms for resolution.  
+-  `[tool.pixi.pypi-dependencies]` : Declares the dependencies to be installed from PyPI (or equivalent sources). These are the external libraries required by the project.
 
 You can specify a range or multiple supported Python versions using the syntax below.
 ```toml
@@ -69,11 +71,11 @@ Final `pyproject.toml` should look like this below, for reference.
 
 ```toml
 [project]
-authors = [{name = "Priyanka O"}]
+authors = [{name = "Priyanka Demo", email = "demo@users.noreply.github.com"}]
 dependencies = []
 name = "greet_me"
 requires-python = ">= 3.11"
-version = "0.1.2"
+version = "0.1.0"
 description = "greet_me Pixi-managed package"
 readme = "README.md"
 
@@ -93,13 +95,14 @@ greet_me = { path = ".", editable = true }
 start = "python -c 'from greet_me import happy; print(happy.greet_happy())'"
 ```
 
-For insipiration, also check [here](https://github.com/prefix-dev/parselmouth/blob/main/pyproject.toml)
+For insipiration, also check [here](https://github.com/prefix-dev/parselmouth/blob/main/pyproject.toml).
 
 ## Lockfiles
 A **lockfile** contains the complete set of dependencies, including specific versions, required to reproduce the project environment. It is automatically generated based on the dependencies listed in the `.toml` file, ensuring that builds remain consistent and reproducible.
 
-
+## Readme
 Please add and update the README.md file, in case you havent done so. You can easily generate a README text on [readme.so](https://readme.so/) and copy its content to your READMe file.
+
 ::::::::::::::::::::::::::::::::::::: keypoints
 - Every project must include a `pyproject.toml` file
 - The `[build-system]` section is required and must define both `requires` and `build-backend`.

episodes/5_project_publishing.md

@@ -30,8 +30,6 @@ The two key tools we need are:
 
 **Twine** – for securely uploading those distributions to **PyPI** or **TestPyPI**.
 
-**Note**: Before proceeding, rename or remove the `pixi.tom`l file, as we will focus on `pyproject.toml`. You may experiment with `pixi.toml` later by removing or renaming `pyproject.toml`.
-
 ##  Step 1: Create your build
 
 The `build` tool reads your `pyproject.toml` file and generates the package distribution files.
@@ -44,7 +42,7 @@ pixi add --pypi build
 ✔ Added build >=1.3.0, <2
 Added these as pypi-dependencies.
 ```
-Empty the depenencies under `[project]` and move/edit them to `[tool.pixi.pypi-dependencies]` section, like shown below : 
+Empty the depenencies under `[project]` and move/edit them to `[tool.pixi.pypi-dependencies]` section, like shown below:
 
 ```toml
 [project]
@@ -54,6 +52,7 @@ dependencies = []
 requests = ">=2.32.5,<3"
 build = ">=1.3.0,<2"
 ```
+Then run the `build` command:
 
 ```bash
 pixi run python -m build
@@ -75,13 +74,13 @@ Successfully built greet_me-0.1.0.tar.gz and greet_me-0.1.0-py3-none-any.whl
  ```
       
 This command creates a `dist` directory containing two files:
+
 - A wheel file (`greet_me-0.1.0-py3-none-any.whl`).
 - A source archive (`greet_me-0.1.0.tar.gz`).
 
 <img width="306" height="533" alt="image" src="https://github.com/user-attachments/assets/503697e4-b93b-45e9-9904-229bd892b47a" />
 
-
- ## Step 2 : Create an account on TestPyPI
+## Step 2 : Create an account on TestPyPI
      
 - Visit [TestPyPI](https://test.pypi.org/account/register/) and create an account.
 - Generate an **API token** from your account settings.
@@ -92,7 +91,7 @@ This command creates a `dist` directory containing two files:
 
 ## Step 3: Upload your build
 The **Twine** tool is used to securely upload your package distributions.
-Install `twine` and modify the `pyroject.toml` file simmilar to what you did for `build` tool above.
+Install `twine` and modify the `pyroject.toml` file as you did for `build` tool above.
 
 ```bash
 pixi add --pypi twine
@@ -116,17 +115,17 @@ Now upload the package to TestPyI
 Uploading distributions to https://test.pypi.org/legacy/
 WARNING  This environment is not supported for trusted publishing                                                     
 Enter your API token: 
-Uploading greet_me1-0.1.7-py3-none-any.whl
+Uploading greet_me-0.1.0-py3-none-any.whl
 100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 4.3/4.3 kB • 00:00 • ?
-Uploading greet_me1-0.1.7.tar.gz
+Uploading greet_me-0.1.0.tar.gz
 100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 12.2/12.2 kB • 00:00 • ?
 
 View at:
-https://test.pypi.org/project/greet-me1/0.1.7/
+https://test.pypi.org/project/greet-me/0.1.0/
   ```
 
 After a successful upload, your package will be available at a URL such as: E.g. : 
-`[https://test.pypi.org/project/po-greet-me/0.1.1/](https://test.pypi.org/project/greet-me1/0.1.7/)`
+[https://test.pypi.org/project/greet-me/0.1.0/](https://test.pypi.org/project/greet-me/0.1.0/).
 
 <img width="1743" height="973" alt="image" src="https://github.com/user-attachments/assets/d41cc3d8-1d9a-4a4e-bdaa-a600fe9d2b1a" />
 
@@ -139,14 +138,14 @@ In that case you may end up in an error like this :
 twine upload --repository testpypi dist/*
 Uploading distributions to https://test.pypi.org/legacy/
 Enter your API token: 
-Uploading greet_me-0.1.1-py3-none-any.whl
+Uploading greet_me-0.1.0-py3-none-any.whl
 100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 2.6/2.6 kB • 00:00 • ?
 WARNING  Error during upload. Retry with the --verbose option for more details.                                                                                                                                            
 ERROR    HTTPError: 403 Forbidden from https://test.pypi.org/legacy/                                                                                                                                                       
     Forbidden
 ```
 
-This isnt always helpful and you should try this command as tipped in the error message above to know more.
+This isn't always helpful and you should try this command as tipped in the error message above to know more.
 
 ```bash
 pixi run twine upload --repository testpypi dist/* --verbose
@@ -218,10 +217,10 @@ pixi run twine upload --repository testpypi dist/*
 
 ## Step 4: Test your package
 
-Create a new Repository with a readme file and install your package from TestPyPI via this command : 
+Create a new repository with a readme file, open a new codespace, and install your package from TestPyPI via this command:
 
 ```bash
-pip install -i https://test.pypi.org/simple/ greet-me1==0.1.7
+pip install -i https://test.pypi.org/simple/ greet-me1==0.1.0
 ```
 
 ```output

episodes/6_extra.md

@@ -42,6 +42,7 @@ Yay! happy day! 😀
 ```
 
 This command will:
+
 - Ensure that the required environment is installed (creating or updating it if necessary).
 - Run the start task exactly as defined in your configuration file.
 

learners/acknowledgements.md

@@ -14,6 +14,7 @@ title: 'Acknowledgements'
 * [Danny Garside](https://orcid.org/0000-0002-4579-003X) was consulted for help with reviewing the course materials, suggesting corrections through pull requests, and facilitating the demo run of the course by organizing the session and leading a post-meeting reflection.
 
 **Resources**
+
 * I would like to thank the PyOpenSci team for their excellent course delivered during the [PyOpenSci Fall Festival 2024](https://github.com/pyOpenSci/ff-2024-create-python-package), which provided valuable inspiration and insights.