DISCnet Workshop: Writing Code as a Team

Setting the Stage

• Introduction to Collaborative Coding
  • Description
  • Aims
  • Learning Objectives
  • Prerequisites
  • Important Information
• Schedule
• The task
  • The data
  • The data analysis plan
  • The code structure

Workshop Notes:

• Getting started
  • Making a clean python environment
  • Clone the repository
  • Installing the workshop’s python package
  • Running tests
• Good coding practices
  • Context transfer
  • Text editors
  • Coding style and linting
• Using GitHub with collaborators
  • Basic concepts
  • Git workflow
  • Writing better commit messages
  • Writing better PRs
  • Writing better code reviews
  • CI (continuous integration)
  • CD (continuous delivery/deployment)
• Code and file structure
  • Organizing your code
  • Code legibility
• Packaging Python code
  • The build system
  • The source code structure
  • Setting dependency versions
  • Installing your package locally
  • Versioning your package
  • Build artifacts
  • Build upload
• Documenting Python code
  • Sphinx
  • Tutorial Driven Development
• Test driven development
  • What are tests
  • Python’s built in unittest library
  • Other python testing libraries
  • Types of tests
  • Test coverage
  • Mocks

API Documentation:

• data_transforms
  • data_transforms package

Indices and tables

• Index

• Module Index