Packaging and publishing python software for research

How to turn your Jupyter notebook into a python package and publish it to PyPI
Start the Course »

Get Basic Code · Report Bug · Request Feature

Table of Contents

1. Prerequisites
2. Contributing
3. License

(back to top)

Prerequisites

This project requires some prerequisites in terms of skill level: you should be proficient with Python, and some understanding of git would be helpful. In addition:

• You must have a GitHub account with available Codespaces hours, or you are welcome to develop locally of course!
• A PyPI or Test PyPI account. This course uses Test PyPI.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under a GNU GPL-3.0 License. See LICENSE for more information.

(back to top)