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

Pybites Podcast

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

1. Introduction (00:00:00)

2. 1. code package (00:01:00)

3. 2. README.md (00:01:22)

4. 3. LICENSE (00:01:58)

5. 4. .gitignore file (00:02:16)

6. 5. tests folder (00:03:03)

7. 6. pyproject.toml + pre-commit (00:03:32)

8. 7. requirements.in and -.txt (00:04:36)

9. 8. CONTRIBUTING.md (00:05:43)

10. 9. .github (actions and issue/PR templates) (00:06:13)

11. 10. docs folder (00:06:48)

12. summary (00:07:24)

13. other files (tox.ini, Makefile, MANIFEST.in) (00:08:07)