4
Summary: The OpenStack Dashboard.
5
Home-page: https://github.com/openstack/horizon/
7
Author-email: horizon@lists.launchpad.net
9
Description: =============================
10
Horizon (OpenStack Dashboard)
11
=============================
13
Horizon is a Django-based project aimed at providing a complete OpenStack
14
Dashboard along with an extensible framework for building new dashboards
15
from reusable components. The ``openstack_dashboard`` module is a reference
16
implementation of a Django site that uses the ``horizon`` app to provide
17
web-based interactions with the various OpenStack projects.
19
For release management:
21
* https://launchpad.net/horizon
23
For blueprints and feature specifications:
25
* https://blueprints.launchpad.net/horizon
29
* https://bugs.launchpad.net/horizon
34
For local development, first create a virtualenv for the project.
35
In the ``tools`` directory there is a script to create one for you:
37
$ python tools/install_venv.py
39
Alternatively, the ``run_tests.sh`` script will also install the environment
40
for you and then run the full test suite to verify everything is installed
41
and functioning correctly.
43
Now that the virtualenv is created, you need to configure your local
44
environment. To do this, create a ``local_settings.py`` file in the
45
``openstack_dashboard/local/`` directory. There is a
46
``local_settings.py.example`` file there that may be used as a template.
48
If all is well you should able to run the development server locally:
50
$ tools/with_venv.sh manage.py runserver
54
$ ./run_tests.sh --runserver
60
The recommended tool for installing and configuring the core OpenStack
61
components is `Devstack`_. Refer to their documentation for getting
62
Nova, Keystone, Glance, etc. up and running.
64
.. _Devstack: http://devstack.org/
70
For development, start with the getting started instructions above.
71
Once you have a working virtualenv and all the necessary packages, read on.
73
If dependencies are added to either ``horizon`` or ``openstack-dashboard``,
74
they should be added to ``tools/pip-requires``.
76
The ``run_tests.sh`` script invokes tests and analyses on both of these
77
components in its process, and it is what Jenkins uses to verify the
78
stability of the project. If run before an environment is set up, it will
79
ask if you wish to install one.
81
To run the unit tests::
85
Building Contributor Documentation
86
==================================
88
This documentation is written by contributors, for contributors.
90
The source is maintained in the ``docs/source`` folder using
91
`reStructuredText`_ and built by `Sphinx`_
93
.. _reStructuredText: http://docutils.sourceforge.net/rst.html
94
.. _Sphinx: http://sphinx.pocoo.org/
96
* Building Automatically::
98
$ ./run_tests.sh --docs
100
* Building Manually::
102
$ export DJANGO_SETTINGS_MODULE=local.local_settings
103
$ python doc/generate_autodoc_index.py
104
$ sphinx-build -b html doc/source build/sphinx/html
106
Results are in the `build/sphinx/html` directory
109
Classifier: Development Status :: 4 - Beta
110
Classifier: Framework :: Django
111
Classifier: Intended Audience :: Developers
112
Classifier: License :: OSI Approved :: Apache Software License
113
Classifier: Operating System :: OS Independent
114
Classifier: Programming Language :: Python
115
Classifier: Topic :: Internet :: WWW/HTTP