Git & Python Workshop: The Complete Curriculum =============================================== Welcome! This is the joint curriculum for a 4-part workshop that teaches git and Python fundamentals to people with little or no prior programming experience (originally written for biotech students). It ties together four separate hands-on repositories into one coherent learning path: #. **Git Basics** — the core git workflow: commits, branches, and merge requests (`cookiecutter-git-workshop-basics `_) #. **Testing** — why and how to test code, plus continuous integration (`cookiecutter-git-workshop-testing `_) #. **Documentation** — writing and publishing documentation with Sphinx (`cookiecutter-git-workshop-documentation `_) #. **Python Packaging** — turning a script into a real, installable, lintable Python package (this repository) Each part below explains the underlying concepts in some depth — not just the button-clicks, but *why* things work the way they do — and is followed by hands-on tasks. The tasks send you to the matching repository above to actually generate a small practice package and work in it; this site is the textbook, the four repositories are where you actually type the commands and touch real files. If you only want a single session's material (e.g. you're only attending the testing workshop), each of the four repositories above also has its own short, standalone documentation site — but reading through here start to finish gives you the full story with fewer gaps. .. toctree:: :maxdepth: 1 :caption: Getting started prerequisites troubleshooting slides .. toctree:: :maxdepth: 2 :caption: Part 1: Git Basics part1-git-basics/index part1-git-basics/tasks .. toctree:: :maxdepth: 2 :caption: Part 2: Testing part2-testing/index part2-testing/tasks .. toctree:: :maxdepth: 2 :caption: Part 3: Documentation part3-documentation/index part3-documentation/tasks .. toctree:: :maxdepth: 2 :caption: Part 4: Python Packaging part4-packaging/index part4-packaging/tasks/basic_packaging part4-packaging/tasks/configure_ci part4-packaging/tasks/conventions .. toctree:: :maxdepth: 1 :caption: Reference glossary Contribute ---------- - Issue Tracker: https://github.com/spirousschuh/git-workshop-py-packaging/issues - Source Code: https://github.com/spirousschuh/git-workshop-py-packaging Support ------- If you encounter issues, please let us know. Indices and tables =================== * :ref:`genindex` * :ref:`modindex` * :ref:`search`