Bob/BEAT Development Tools

This package provides tools to help maintain Bob and BEAT.

Documentation

• Installation
  • Setup
• Local development of packages
  • TLDR
  • Local development of existing packages
  • Local development of a new package
• Additional Considerations
  • Unit tests
  • Continuous integration (CI)
  • Python package namespace
  • Distributing your work
  • buildout.cfg in more details
  • Anatomy of a new package
  • Continuous Integration and Deployment (CI)
  • New unexisting dependencies
  • Updating a dependency version
  • Conda recipe
  • Database packages and packages with extra data
  • Licensing
  • Headers
  • The setup.py file
  • Buildout
  • The README.rst file
  • Sphinx documentation
  • Project logo and branding
• Release Management
  • Usage
  • Manually update changelog
  • Releasing the Bob meta package
  • Releasing the docs meta package
• Python API
  • Detailed Information
• Instructions for CI machine installation
  • Deploying a Linux-based CI
  • Deploying a macOS-based CI

Indices and tables

• Index

• Module Index

• Search Page