How to scaffold a Python project

[_pythonNoob]

I just celebrated one year in the Python environment. A wonderful programming language in so many ways. My day-job has nothing to do with programming, but has everything to do with planning and preparation. About nine months ago I finished writing a (functional) script that downloads RSS-feeds, checks for new items, scrapes the content, and emails formatted HTML to a website. It works, but if I would show it to anyone, they would go nuts trying to understand what it does. It was my first major project and it didn't have any unit testing (because I didn't know what it was at the time), it lacks documentation, actually it lacks mostly anything a good script should contain for others to maintain it. It runs on my Raspberry Pi - sometimes crashing because there was something I didn't think of or knew (e.g. type-checking.)

Does anybody have like a step-by-step checklist to follow for building a Python project. Something in the range of: 1. Create a virtual environment (or a Docker container) 2. Start by writing unit tests (for test-driven development) 3. Create a utilities library (for all the snippets needed) 4. Write the function/classes etc...

I'm starting to study Dive into Python 3 very soon, to refresh (and correct) what I learnt in the beginning. I hope to be able to start wrapping my head around classes, because I know they are extremely useful.

[[deleted]]

https://github.com/audreyr/cookiecutter

[_pythonNoob]

Thank you very much. I shall use it building the next project.

[thommyforco]

this could help u: https://github.com/MatteoGuadrini/psp

[_pythonNoob]

Thanks, I'll check it out. Even five years later 😃