#161 - 10 Essential Things to Add to Your Python Project on GitHub

In this episode of the Pybites Podcast, hosts Bob Belderbos dives into the essential components you need for a successful public Python project on GitHub.

From organizing your code and creating a standout README.md to setting up automated tests and ensuring your project is contribution-friendly, he covers everything to help you build a robust and collaborative Python project.

Whether you're a seasoned developer or just starting out, these tips will enhance your project's usability, maintainability, and community engagement.

Join the discussion and learn how to set a solid foundation for your open-source projects ...

Mentioned / related links:
- Starting a Python project - poetry, pip-tools, git + GitHub, package or not?
- Using pip-tools to manage Python dependencies
- Increase Python code quality with pre-commit
- How to handle environment variables in Python
- How to test a Python project against multiple versions using tox
- What are Makefiles and why + how to use them in your Python projects

Chapters

• 0:00 Introduction
• 1:00 1. code package
• 1:22 2. README.md
• 1:58 3. LICENSE
• 2:16 4. .gitignore file
• 3:03 5. tests folder
• 3:32 6. pyproject.toml + pre-commit
• 4:36 7. requirements.in and -.txt
• 5:43 8. CONTRIBUTING.md
• 6:13 9. .github (actions and issue/PR templates)
• 6:48 10. docs folder
• 7:24 summary
• 8:07 other files (tox.ini, Makefile, MANIFEST.in)