doc/source/devref/development.environment.rst

   1 ..
   2       Copyright 2010-2013 United States Government as represented by the
   3       Administrator of the National Aeronautics and Space Administration.
   4       All Rights Reserved.
   5
   6       Licensed under the Apache License, Version 2.0 (the "License"); you may
   7       not use this file except in compliance with the License. You may obtain
   8       a copy of the License at
   9
  10           http://www.apache.org/licenses/LICENSE-2.0
  11
  12       Unless required by applicable law or agreed to in writing, software
  13       distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  14       WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  15       License for the specific language governing permissions and limitations
  16       under the License.
  17
  18
  19       Convention for heading levels in Neutron devref:
  20       =======  Heading 0 (reserved for the title in a document)
  21       -------  Heading 1
  22       ~~~~~~~  Heading 2
  23       +++++++  Heading 3
  24       '''''''  Heading 4
  25       (Avoid deeper levels because they do not render well.)
  26
  27
  28 Setting Up a Development Environment
  29 ====================================
  30
  31 This page describes how to setup a working Python development
  32 environment that can be used in developing Neutron on Ubuntu, Fedora or
  33 Mac OS X. These instructions assume you're already familiar with
  34 Git and Gerrit, which is a code repository mirror and code review toolset
  35 , however if you aren't please see `this Git tutorial`_ for an introduction
  36 to using Git and `this guide`_ for a tutorial on using Gerrit and Git for
  37 code contribution to OpenStack projects.
  38
  39 .. _this Git tutorial: http://git-scm.com/book/en/Getting-Started
  40 .. _this guide: http://docs.openstack.org/infra/manual/developers.html#development-workflow
  41
  42 Following these instructions will allow you to run the Neutron unit
  43 tests. If you want to be able to run Neutron in a full OpenStack environment,
  44 you can use the excellent `DevStack`_ project to do so. There is a wiki page
  45 that describes `setting up Neutron using DevStack`_.
  46
  47 .. _DevStack: https://git.openstack.org/cgit/openstack-dev/devstack
  48 .. _setting up Neutron using Devstack: https://wiki.openstack.org/wiki/NeutronDevstack
  49
  50 Getting the code
  51 ----------------
  52
  53 Grab the code::
  54
  55     git clone git://git.openstack.org/openstack/neutron.git
  56     cd neutron
  57
  58
  59 .. include:: ../../../TESTING.rst