https://github.com/trisha/pypi_packaging_tutorial

https://packaging.python.org/en/latest/tutorials/packaging-projects/
https://github.com/trisha/pypi_packaging_tutorial

Last synced: about 2 months ago
JSON representation

https://packaging.python.org/en/latest/tutorials/packaging-projects/

• Host: GitHub
• URL: https://github.com/trisha/pypi_packaging_tutorial
• Owner: trisha
• License: mit
• Created: 2023-12-06T03:22:06.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-11T05:25:39.000Z (about 1 year ago)
• Last Synced: 2023-12-12T07:28:25.624Z (about 1 year ago)
• Language: Python
• Size: 7.81 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Example PyPi Package

This is a simple example package from the [tutorial](https://packaging.python.org/en/latest/tutorials/packaging-projects/) from [pypi](https://pypi.org/). You can use

[GitHub-flavored Markdown](https://guides.github.com/features/mastering-markdown/)

to write your content.

- More info on .toml: https://packaging.python.org/en/latest/guides/writing-pyproject-toml/

# Confirming that it works

Once it gets uploaded (FYI the test server occassionaly deletes packages so would have to reupload), enter the below in Terminal/iTerm2:

`ipython` to enter virtual environment

`!python3 -m pip install --index-url https://test.pypi.org/simple/ --no-deps example-package-trishie` the ! in front is an escape character that tells iPython that it's a terminal command

`!python3` to enter interpreter

```from example_package_trishie import example

example.add_one(2)``` should return 3!

The instructions above for testing are slightly different when on main network instead of test network but the differences are described in the pet project tutorial in the [Next Steps](https://packaging.python.org/en/latest/tutorials/packaging-projects/#next-steps) section.