Andreas Jaeger e7885499dd Cleanup py27 and docs support
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove python 2.7 stanza from setup.py
- Remove obsolete sections from setup.cfg
- Update classifiers
- Update requirements, no need for python_version anymore
- Cleanup doc/source/conf.py to remove now obsolete content,
  use sphinxcontrib.apidoc to build module index again (this
  seems to have been broken when switching to sphinx-build).
- Remove install_command from tox.ini, the default is fine
- Use TOX_CONSTRAINTS_FILE instead of obsolete UPPER_CONSTRAINTS_FILE.
- Update tox.ini for python3 only support.

Change-Id: Id8738ecfb0f578d2a7953c63ffe10779f835bcaf
2020-06-05 12:04:30 +02:00

1.2 KiB

Developer Guide

design components invocation caches developing_elements dib_lint stable_interfaces vhd_creation Module index <api/modules>

This documentation explains how to get started with creating your own disk-image-builder elements as well as some high level concepts for element creation.

Quickstart

To get started developing with diskimage-builder, install to a virtualenv:

$ mkdir dib
$ cd dib
$ virtualenv env
$ source env/bin/activate
$ git clone https://opendev.org/openstack/diskimage-builder
$ cd diskimage-builder
$ pip install -e .

You can now simply use disk-image-create to start building images and testing your changes. When you are done editing, use git review to submit changes to the upstream gerrit.

Python module documentation

For internal documentation on the DIB python components, see the modindex.

Finding Work

We maintain a list of low-hanging-fruit tags on launchpad: