TrainTrack: Turning a Python Script to a Sharable and Testable Package

[raamana]

Turning Your Python Script into a Sharable and Testable Package

Project Description

Although many code in Python and share their code, it's still a bit niche to take up proper testing of its implementation, and package it for easy distribution via pip. That's partly due to lack of understanding of how they work, and how easy they are once they work. I want to demystify them with a live coding task.

Skills required to participate

Basic python skills would help, but anyone with a reasonable programming skills will benefit from it.

Preparation material

• Install Python 3
• Install pytest and hypothesis

Link to your GitHub repo

To be added

Communication

To be done

Link to the communication channel for your project. You can, for example, create a slack channel for your project inside the Brainhack slack community, and include a slack badge to invite people to Brainhack slack, where they can then find and join your channel.
Or create a community on gitter and link to the chat by including a Gitter badge linking to your community

PS

I am not yet 100% sure I can make it to OHBM yet!

[katjaq]

\ö// Our first project proposal started! 💯 That sounds great!!
We hope very much that you will be able to come!!
The idea was that you replace our placeholders with your title for example :) Maybe you can do that during your next update :)
Looking forward!! :)

[KirstieJane]

Wooo! Thanks @raamana!! ✨✨✨

[jdkent]

Just saw a realpython article on twitter that is relevant to this project.

[raamana]

Thanks James - RealPythons tutorials are solid in general. If I end up doing this tutorial (pending the lottery and few other factors), I will certainly use and build on all the existing material.

[jovo]

i wonder if google collab or gigantum can help?

[raamana]

They would. They are great services for a data oriented project. But given this tutorial would be focused on turning a script into a package (pypi structure), show how to test it (in a separate file), and distribute / maintain it, i don’t think a notebook-like service would be ideal for it. We’ll see - once the schedule is finalized (and if I’m the leader), I’ll get started working on this.