openstack
/
horizon
Code Issues Proposed changes
OpenStack Dashboard (Horizon)
2,702 Commits 9 Branches 47 Tags 313 MiB
Python 63%
JavaScript 28.9%
HTML 6.5%
SCSS 1.5%
Go to file
Kun Huang f585152407 remove 'import *' usage (or mark is #noqa) 
This is talked in bug #1188533, and in current codes, there are several
places here:

horizon/forms/__init__.py:18:from django.forms import *
    mark '# noqa'

openstack_dashboard/settings.py:182:    from local.local_settings import *
openstack_dashboard/test/settings.py:5:from horizon.test.settings import *
    mark '# noqa'

openstack_dashboard/dashboards/project/instances/workflows/__init__.py:1:from create_instance import *
openstack_dashboard/dashboards/project/instances/workflows/__init__.py:2:from update_instance import *
openstack_dashboard/dashboards/project/instances/workflows/__init__.py:3:from resize_instance import *
    fix it

openstack_dashboard/dashboards/project/images_and_snapshots/urls.py:21:from django.conf.urls.defaults import *
    fix it

fixes bug # 1188533
Change-Id: Id671280903f8452a78f81f1240d92297de7a89a8
 		2013-07-30 11:45:39 +08:00
.tx Final translations for Folsom. 2012-09-18 15:26:19 -07:00
bin Readding bin dir which was mistakenly deleted. 2012-10-12 15:35:19 -07:00
doc Merge "Use oslo.sphinx and remove local copy of doc theme" 2013-07-23 08:46:03 +00:00
horizon remove 'import *' usage (or mark is #noqa) 2013-07-30 11:45:39 +08:00
openstack_dashboard remove 'import *' usage (or mark is #noqa) 2013-07-30 11:45:39 +08:00
tools Renames tools/pip-requires to requirements.txt 2013-05-29 12:07:35 +02:00
.gitignore Added openstack_dashboard/local/.secret_key_store to .gitignore. 2013-02-11 17:12:56 +00:00
.gitreview Add .gitreview and rfc.sh. 2011-10-28 09:50:35 -04:00
.mailmap remove 'import *' usage (or mark is #noqa) 2013-07-30 11:45:39 +08:00
.pylintrc updating run_tests.sh to mimic other openstack projects, pep8, pylint, coverage 2011-08-31 14:41:36 -07:00
HACKING.rst Add HACKING.rst 2013-06-11 10:52:50 -07:00
LICENSE Initial commit 2011-01-12 13:43:31 -08:00
MANIFEST.in Renames tools/pip-requires to requirements.txt 2013-05-29 12:07:35 +02:00
Makefile Unifies the project packaging into one set of modules. 2012-02-29 00:20:13 -08:00
README.rst Renames tools/pip-requires to requirements.txt 2013-05-29 12:07:35 +02:00
manage.py Fix PEP8 issues. 2012-08-29 15:53:07 +08:00
openstack-common.conf Add openstack-common 2013-07-11 10:59:56 +02:00
requirements.txt Update heat and ceilometer clients requirements 2013-07-29 14:14:26 +02:00
run_tests.sh Unpinning upper bound on python-*clients 2013-07-23 09:41:31 -06:00
setup.cfg Migrate to PBR for build tooling. 2013-04-27 11:56:07 -04:00
setup.py Pinning minimum pbr and d2to1 versions 2013-07-12 10:52:14 -06:00
test-requirements.txt Use oslo.sphinx and remove local copy of doc theme 2013-07-05 16:10:43 -04:00
tox.ini remove 'import *' usage (or mark is #noqa) 2013-07-30 11:45:39 +08:00

README.rst

Horizon (OpenStack Dashboard)

Horizon is a Django-based project aimed at providing a complete OpenStack Dashboard along with an extensible framework for building new dashboards from reusable components. The openstack_dashboard module is a reference implementation of a Django site that uses the horizon app to provide web-based interactions with the various OpenStack projects.

For release management:

For blueprints and feature specifications:

For issue tracking:

Dependencies

To get started you will need to install Node.js (http://nodejs.org/) on your machine. Node.js is used with Horizon in order to use LESS (http://lesscss.org/) for our CSS needs. Horizon is currently using Node.js v0.6.12.

For Ubuntu use apt to install Node.js:

$ sudo apt-get install nodejs

For other versions of Linux, please see here:: http://nodejs.org/#download for how to install Node.js on your system.

Getting Started

For local development, first create a virtualenv for the project. In the tools directory there is a script to create one for you:

$ python tools/install_venv.py

Alternatively, the run_tests.sh script will also install the environment for you and then run the full test suite to verify everything is installed and functioning correctly.

Now that the virtualenv is created, you need to configure your local environment. To do this, create a local_settings.py file in the openstack_dashboard/local/ directory. There is a local_settings.py.example file there that may be used as a template.

If all is well you should able to run the development server locally:

$ tools/with_venv.sh manage.py runserver

or, as a shortcut:

$ ./run_tests.sh --runserver

Settings Up OpenStack

The recommended tool for installing and configuring the core OpenStack components is Devstack. Refer to their documentation for getting Nova, Keystone, Glance, etc. up and running.

Note

The minimum required set of OpenStack services running includes the following:

  • Nova (compute, api, scheduler, network, and volume services)
  • Glance
  • Keystone

Optional support is provided for Swift.

Development

For development, start with the getting started instructions above. Once you have a working virtualenv and all the necessary packages, read on.

If dependencies are added to either horizon or openstack-dashboard, they should be added to requirements.txt.

The run_tests.sh script invokes tests and analyses on both of these components in its process, and it is what Jenkins uses to verify the stability of the project. If run before an environment is set up, it will ask if you wish to install one.

To run the unit tests:

$ ./run_tests.sh

Building Contributor Documentation

This documentation is written by contributors, for contributors.

The source is maintained in the doc/source folder using reStructuredText and built by Sphinx

  • Building Automatically:

    $ ./run_tests.sh --docs

  • Building Manually:

    $ export DJANGO_SETTINGS_MODULE=local.local_settings
$ python doc/generate_autodoc_index.py
$ sphinx-build -b html doc/source build/sphinx/html

Results are in the build/sphinx/html directory