Skip to content

Commit 7adf1c4

Browse files
committed
Fix: edits from Moritz and Trevor
1 parent 2304afd commit 7adf1c4

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

tutorials/1-installable-code.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -433,10 +433,10 @@ You can now import your package and access the `add_num` function.
433433
434434
```bash
435435
➜ python
436-
Python 3.11.4 | packaged by conda-forge | (main, Jun 10 2023, 18:08:41) [Clang 15.0.7 ] on darwin
436+
Python 3.11.4 | packaged by conda-forge
437437
Type "help", "copyright", "credits" or "license" for more information.
438-
>>> import pyospackage
439-
>>> pyospackage.add_num(1, 2)
438+
>>> from pyospackage.add_numbers import add_num
439+
>>> add_num(1, 2)
440440
3
441441
```
442442
@@ -450,11 +450,17 @@ always install packages directly from GitHub using the syntax:
450450
pip install git+https://github.com/user/repo.git@branch_or_tag
451451
```
452452
453-
To make your package github installable, you can simply:
453+
To make your package GitHub installable, you can:
454454
455-
1. Create a new GitHub repo
455+
1. Create a new GitHub repository
456456
2. Push the contents of the project directory that you created above, to GitHub
457-
3. Finally install the package from GitHub using the command above.
457+
3. Finally install the package from GitHub using the command above. When you use the command above, don't forget to substitute the user, repo, and branch_or_tag with your specific values.
458+
459+
For instance below you install the pyospackage from the main branch of the
460+
pyOpenSci repository.
461+
462+
`pip install git+https://github.com/user/repo.git@branch_or_tag`
463+
458464
:::
459465
460466
## Congratulations! You created your first Python package

0 commit comments

Comments
 (0)