Pybites Podcast 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 ...
Chapters:
00:00 intro
01:00 1. code package
01:22 2. README.md
01:58 3. LICENSE
02:16 4. .gitignore file
03:03 5. tests folder
03:32 6. pyproject.toml + pre-commit
04:36 7. requirements.in and -.txt
05:43 8. CONTRIBUTING.md
06:13 9. .github (actions and issue/PR templates)
06:48 10. docs folder
07:24 summary
08:07 other files (tox.ini, Makefile, MANIFEST.in)
09.08 wrap up
09:53 outro
Mentioned / related links:
Starting a Python project - poetry, pip-tools, git + GitHub, package or not? • Starting a Python project - poetry, p...
Using pip-tools to manage Python dependencies: • Using pip-tools to manage Python depe...
Increase Python code quality with pre-commit: • Increase Python code quality with pre...
How to handle environment variables in Python: https://pybit.es/articles/how-to-hand...
How to test a Python project against multiple versions using tox: • How to test a Python project against ...
What are Makefiles and why + how to use them in your Python projects: • What are Makefiles and why + how to u...