76b81e1f26
In order to create a virtualenv with tox, a postgresql package is needed as a prerequisite. The dev-quickstart documentation has been updated to reflect this. In addition, the prerequisites for Fedora/RHEL were modified, because mysql-devel is needed, not mysql-libs. Fixes bug: #1227390 Change-Id: Ibfdb0a9a3d560fcc3fb7d95aaa1d765ed18215e2
57 lines
1.3 KiB
ReStructuredText
57 lines
1.3 KiB
ReStructuredText
.. _dev-quickstart:
|
|
|
|
=====================
|
|
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.
|
|
|
|
.. seealso::
|
|
|
|
https://wiki.openstack.org/wiki/GerritWorkflow
|
|
|
|
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
|
|
|
|
# Fedora/RHEL:
|
|
sudo yum install python-devel swig openssl-devel python-pip mysql-devel libxml2-devel libxslt-devel postgresql-devel
|
|
|
|
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
|