Developer Guide

This guide is for contributors and maintainers of rms-picmaker. It complements the User Guide (which is end-user facing) and the picmaker Module reference (which is the auto-generated API).

If you only want to convert images, read the User Guide. If you want to understand the pipeline, change the code, or release a new version, read this.

Developer Guide contents:

• Repository overview
  • Setting up a development environment
  • Layout
• Module-by-module description
  • picmaker (src/picmaker/__init__.py)
  • picmaker.cli (src/picmaker/cli.py)
  • picmaker.pipeline (src/picmaker/pipeline.py)
  • picmaker.options (src/picmaker/options.py)
  • picmaker.io (src/picmaker/io.py)
  • picmaker.enhance (src/picmaker/enhance.py)
  • picmaker.geometry (src/picmaker/geometry.py)
  • picmaker.color (src/picmaker/color.py)
  • picmaker.pil_utils (src/picmaker/pil_utils.py)
  • picmaker._filters (src/picmaker/_filters.py)
  • picmaker._rgb (src/picmaker/_rgb.py)
  • picmaker.tiff16 (src/picmaker/tiff16.py)
  • picmaker.colornames (src/picmaker/colornames.py)
  • picmaker.instruments (src/picmaker/instruments/)
• Pipeline
  • Flowchart
  • Major functions
• Running the test suite
• Adding a new instrument
  • The four-function protocol
  • Step-by-step
  • When to break the protocol
• Releasing to PyPI
  • One-time setup (release blocker for the first publish)
  • Cutting a release

Where to look next

• The full API reference: picmaker Module.

• End-user documentation: User Guide.

• Open work tracked in GitHub issues.

• The contributor workflow: Contributing.