openstack/ironic
Code Issues Proposed changes
ironic/doc/source/dev/dev-quickstart.rst
Jim Rollenhagen 7eb48adc82 Add git dependency to quickstart docs 
Without git installed, `tox -evenv -- echo 'done'` fails with a
cryptic error message. This should keep newcomers from getting
stuck on this.

Change-Id: I7cd7faa3bda905c8cfb3cfb456e3279566edf613
2014-02-11 09:47:59 -08:00

1.3 KiB
Raw Blame History

Developer Quick-Start

This is a quick walkthrough to get you started developing code for Ironic. This assumes you are already familiar with submitting code reviews to an OpenStack project.

Ironic source code should be pulled directly from git:

cd <your source dir>
git clone https://github.com/openstack/ironic
cd ironic

Install prerequisites:

# Ubuntu/Debian:
sudo apt-get install python-dev swig libssl-dev python-pip libmysqlclient-dev libxml2-dev libxslt-dev libpq-dev git

# Fedora/RHEL:
sudo yum install python-devel swig openssl-devel python-pip mysql-devel libxml2-devel libxslt-devel postgresql-devel git

sudo easy_install nose
sudo pip install virtualenv setuptools-git flake8 tox

Setting up a local environment for development can be done with tox:

# create virtualenv
tox -evenv -- echo 'done'

# activate the virtualenv
source .tox/venv/bin/activate

# run testr init
testr init

To run the pep8/flake8 syntax and style checks:

# run pep8/flake8 checks
flake8

To run Ironic's unit test suite:

# run unit tests
testr run

When you're done, to leave the venv:

# deactivate the virtualenv
deactivate