Bob Package Development

This module contains information on how to build, maintain, and distribute Bob packages written in pure Python or a mix of C/C++ and Python.

By following these instructions you will be able to:

• Setup a local development environment.

• Download and install Bob packages and other software into your development environment.

• Implement your own package including either pure Python code, a mixture of C/C++ and Python code, and even pure C/C++ libraries with clean C/C++ interfaces.

  Note

  If possible, you should try to develop new packages using Python only, since they are easier to maintain.

• Distribute your work to others in a clean and organized manner.

Documentation

• Local development environement
• Python package development
  • Anatomy of a package
  • Setting up your package
  • Building your package
• C/C++ modules in your package
  • Setting up your package
  • Building your package
  • Helper utilities
• C/C++ libraries in your package
  • Setting up your package
  • Building your package
• Documenting your package
  • Documenting Python code
  • Documenting your C/C++ Python Extension
• Additional considerations
  • Unit tests
  • Continuous integration (CI)
  • Python package namespace
  • Distributing your work
• Python API
  • Functions
  • Scripts
• C++ API of the Documentation classes
  • Function Documentation
  • Variables Documentation
  • Class Documentation
• Using pip for development
  • Developing a C++ Package
  • Developing Several Packages from Source

Indices and tables

• Index
• Module Index
• Search Page