Permalink
Browse files

Unifies the project packaging into one set of modules.

There are no longer two separate projects living inside the horizon
repository. There is a single project now with a single setup.py,
single README, etc.

The openstack-dashboard/dashboard django project is now named
"openstack_dashboard" and lives as an example project in the
topmost horizon directory.

The "horizon/horizon" directory has been bumped up a level and now
is directly on the path when the root horizon directory is on
your python path.

Javascript media which the horizon module directly relies upon
now ships in the horizon/static dir rather than
openstack-dashboard/dashboard/static.

All the corresponding setup, installation, build, and env scripts
have been updated accordingly.

Implements blueprint unified-packaging.

Change-Id: Ieed8e3c777432cd046c3e0298869a9428756ab62
  • Loading branch information...
1 parent fca0b64 commit 052aa55d34a8d9ee9a58969c3a20587cac9adc04 @gabrielhurley gabrielhurley committed Feb 29, 2012
Showing 452 changed files with 194 additions and 2,510 deletions.
View
@@ -8,10 +8,8 @@ coverage.xml
pep8.txt
pylint.txt
reports
-horizon/horizon.egg-info
-.horizon-venv
-openstack-dashboard/local/dashboard_openstack.sqlite3
-openstack-dashboard/local/local_settings.py
+horizon.egg-info
+openstack_dashboard/local/local_settings.py
docs/build/
docs/source/sourcecode
.venv
File renamed without changes.
View
@@ -1,17 +1,12 @@
-OpenStack Dashboard (Horizon)
------------------------------
+=============================
+Horizon (OpenStack Dashboard)
+=============================
-The OpenStack Dashboard is a Django based reference implementation of a web
-based management interface for OpenStack.
-
-It is based on the ``horizon`` module, which is designed to be a generic Django
-app that can be re-used in other projects.
-
-For more information about how to get started with the OpenStack Dashboard,
-view the README file in the openstack-dashboard folder.
-
-For more information about working directly with ``horizon``, see the
-README file in the ``horizon`` folder.
+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:
@@ -25,38 +20,62 @@ For issue tracking:
* https://bugs.launchpad.net/horizon
+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 ``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
+=====================
-Project Structure and Testing:
-------------------------------
+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.
-This project is a bit different from other OpenStack projects in that it has
-two very distinct components underneath it: ``horizon``, and
-``openstack-dashboard``.
+.. _Devstack: http://devstack.org/
-The ``horizon`` directory holds the generic libraries and components that can
-be used in any Django project.
-The ``openstack-dashboard`` directory contains a reference Django project that
-uses ``horizon``.
+Development
+===========
-For development, both pieces share an environment which (by default) is
-built with the ``tools/install_venv.py`` script. That script creates a
-virtualenv and installs all the necessary packages.
+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 ``tools/pip-requires``.
The ``run_tests.sh`` script invokes tests and analyses on both of these
-components in its process, and is what Jenkins uses to verify the
+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 tests::
+To run the unit tests::
$ ./run_tests.sh
Building Contributor Documentation
-----------------------------------
+==================================
This documentation is written by contributors, for contributors.
View
@@ -15,14 +15,12 @@
import os
BASE_DIR = os.path.dirname(os.path.abspath(__file__))
-HORIZON_DIR = os.path.abspath(os.path.join(BASE_DIR, "..", "..", "horizon"))
-DASHBOARD_DIR = os.path.abspath(os.path.join(BASE_DIR, "..", "..", "openstack-dashboard"))
+ROOT = os.path.abspath(os.path.join(BASE_DIR, "..", ".."))
-sys.path.insert(0, HORIZON_DIR)
-sys.path.insert(0, DASHBOARD_DIR)
+sys.path.insert(0, ROOT)
# This is required for ReadTheDocs.org, but isn't a bad idea anyway.
-os.environ['DJANGO_SETTINGS_MODULE'] = 'dashboard.settings'
+os.environ['DJANGO_SETTINGS_MODULE'] = 'openstack_dashboard.settings'
import horizon.version
@@ -37,8 +35,6 @@ def find_autodoc_modules(module_name, sourcedir):
for root, dirs, files in os.walk("."):
for filename in files:
if filename.endswith(".py"):
- # root = ./dashboard/test/unit
- # filename = base.py
# remove the pieces of the root
elements = root.split(os.path.sep)
# replace the leading "." with the module name
@@ -53,10 +49,10 @@ def find_autodoc_modules(module_name, sourcedir):
return modlist
RSTDIR = os.path.abspath(os.path.join(BASE_DIR, "sourcecode"))
- SRCS = {'horizon': HORIZON_DIR,
- 'dashboard': DASHBOARD_DIR}
+ SRCS = {'horizon': ROOT,
+ 'openstack_dashboard': ROOT}
- EXCLUDED_MODULES = ('horizon.tests', 'dashboard.tests',)
+ EXCLUDED_MODULES = ('horizon.tests', 'openstack_dashboard.tests',)
CURRENT_SOURCES = {}
if not(os.path.exists(RSTDIR)):
@@ -118,7 +114,7 @@ def find_autodoc_modules(module_name, sourcedir):
# Delete auto-generated .rst files for sources which no longer exist
for directory, subdirs, files in list(os.walk(RSTDIR)):
for old_file in files:
- if old_file not in CURRENT_SOURCES[directory]:
+ if old_file not in CURRENT_SOURCES.get(directory, []):
print "Removing outdated file for %s" % old_file
os.remove(os.path.join(directory, old_file))
View
@@ -1,176 +0,0 @@
-
- Apache License
- Version 2.0, January 2004
- http://www.apache.org/licenses/
-
- TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
- 1. Definitions.
-
- "License" shall mean the terms and conditions for use, reproduction,
- and distribution as defined by Sections 1 through 9 of this document.
-
- "Licensor" shall mean the copyright owner or entity authorized by
- the copyright owner that is granting the License.
-
- "Legal Entity" shall mean the union of the acting entity and all
- other entities that control, are controlled by, or are under common
- control with that entity. For the purposes of this definition,
- "control" means (i) the power, direct or indirect, to cause the
- direction or management of such entity, whether by contract or
- otherwise, or (ii) ownership of fifty percent (50%) or more of the
- outstanding shares, or (iii) beneficial ownership of such entity.
-
- "You" (or "Your") shall mean an individual or Legal Entity
- exercising permissions granted by this License.
-
- "Source" form shall mean the preferred form for making modifications,
- including but not limited to software source code, documentation
- source, and configuration files.
-
- "Object" form shall mean any form resulting from mechanical
- transformation or translation of a Source form, including but
- not limited to compiled object code, generated documentation,
- and conversions to other media types.
-
- "Work" shall mean the work of authorship, whether in Source or
- Object form, made available under the License, as indicated by a
- copyright notice that is included in or attached to the work
- (an example is provided in the Appendix below).
-
- "Derivative Works" shall mean any work, whether in Source or Object
- form, that is based on (or derived from) the Work and for which the
- editorial revisions, annotations, elaborations, or other modifications
- represent, as a whole, an original work of authorship. For the purposes
- of this License, Derivative Works shall not include works that remain
- separable from, or merely link (or bind by name) to the interfaces of,
- the Work and Derivative Works thereof.
-
- "Contribution" shall mean any work of authorship, including
- the original version of the Work and any modifications or additions
- to that Work or Derivative Works thereof, that is intentionally
- submitted to Licensor for inclusion in the Work by the copyright owner
- or by an individual or Legal Entity authorized to submit on behalf of
- the copyright owner. For the purposes of this definition, "submitted"
- means any form of electronic, verbal, or written communication sent
- to the Licensor or its representatives, including but not limited to
- communication on electronic mailing lists, source code control systems,
- and issue tracking systems that are managed by, or on behalf of, the
- Licensor for the purpose of discussing and improving the Work, but
- excluding communication that is conspicuously marked or otherwise
- designated in writing by the copyright owner as "Not a Contribution."
-
- "Contributor" shall mean Licensor and any individual or Legal Entity
- on behalf of whom a Contribution has been received by Licensor and
- subsequently incorporated within the Work.
-
- 2. Grant of Copyright License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- copyright license to reproduce, prepare Derivative Works of,
- publicly display, publicly perform, sublicense, and distribute the
- Work and such Derivative Works in Source or Object form.
-
- 3. Grant of Patent License. Subject to the terms and conditions of
- this License, each Contributor hereby grants to You a perpetual,
- worldwide, non-exclusive, no-charge, royalty-free, irrevocable
- (except as stated in this section) patent license to make, have made,
- use, offer to sell, sell, import, and otherwise transfer the Work,
- where such license applies only to those patent claims licensable
- by such Contributor that are necessarily infringed by their
- Contribution(s) alone or by combination of their Contribution(s)
- with the Work to which such Contribution(s) was submitted. If You
- institute patent litigation against any entity (including a
- cross-claim or counterclaim in a lawsuit) alleging that the Work
- or a Contribution incorporated within the Work constitutes direct
- or contributory patent infringement, then any patent licenses
- granted to You under this License for that Work shall terminate
- as of the date such litigation is filed.
-
- 4. Redistribution. You may reproduce and distribute copies of the
- Work or Derivative Works thereof in any medium, with or without
- modifications, and in Source or Object form, provided that You
- meet the following conditions:
-
- (a) You must give any other recipients of the Work or
- Derivative Works a copy of this License; and
-
- (b) You must cause any modified files to carry prominent notices
- stating that You changed the files; and
-
- (c) You must retain, in the Source form of any Derivative Works
- that You distribute, all copyright, patent, trademark, and
- attribution notices from the Source form of the Work,
- excluding those notices that do not pertain to any part of
- the Derivative Works; and
-
- (d) If the Work includes a "NOTICE" text file as part of its
- distribution, then any Derivative Works that You distribute must
- include a readable copy of the attribution notices contained
- within such NOTICE file, excluding those notices that do not
- pertain to any part of the Derivative Works, in at least one
- of the following places: within a NOTICE text file distributed
- as part of the Derivative Works; within the Source form or
- documentation, if provided along with the Derivative Works; or,
- within a display generated by the Derivative Works, if and
- wherever such third-party notices normally appear. The contents
- of the NOTICE file are for informational purposes only and
- do not modify the License. You may add Your own attribution
- notices within Derivative Works that You distribute, alongside
- or as an addendum to the NOTICE text from the Work, provided
- that such additional attribution notices cannot be construed
- as modifying the License.
-
- You may add Your own copyright statement to Your modifications and
- may provide additional or different license terms and conditions
- for use, reproduction, or distribution of Your modifications, or
- for any such Derivative Works as a whole, provided Your use,
- reproduction, and distribution of the Work otherwise complies with
- the conditions stated in this License.
-
- 5. Submission of Contributions. Unless You explicitly state otherwise,
- any Contribution intentionally submitted for inclusion in the Work
- by You to the Licensor shall be under the terms and conditions of
- this License, without any additional terms or conditions.
- Notwithstanding the above, nothing herein shall supersede or modify
- the terms of any separate license agreement you may have executed
- with Licensor regarding such Contributions.
-
- 6. Trademarks. This License does not grant permission to use the trade
- names, trademarks, service marks, or product names of the Licensor,
- except as required for reasonable and customary use in describing the
- origin of the Work and reproducing the content of the NOTICE file.
-
- 7. Disclaimer of Warranty. Unless required by applicable law or
- agreed to in writing, Licensor provides the Work (and each
- Contributor provides its Contributions) on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
- implied, including, without limitation, any warranties or conditions
- of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
- PARTICULAR PURPOSE. You are solely responsible for determining the
- appropriateness of using or redistributing the Work and assume any
- risks associated with Your exercise of permissions under this License.
-
- 8. Limitation of Liability. In no event and under no legal theory,
- whether in tort (including negligence), contract, or otherwise,
- unless required by applicable law (such as deliberate and grossly
- negligent acts) or agreed to in writing, shall any Contributor be
- liable to You for damages, including any direct, indirect, special,
- incidental, or consequential damages of any character arising as a
- result of this License or out of the use or inability to use the
- Work (including but not limited to damages for loss of goodwill,
- work stoppage, computer failure or malfunction, or any and all
- other commercial damages or losses), even if such Contributor
- has been advised of the possibility of such damages.
-
- 9. Accepting Warranty or Additional Liability. While redistributing
- the Work or Derivative Works thereof, You may choose to offer,
- and charge a fee for, acceptance of support, warranty, indemnity,
- or other liability obligations and/or rights consistent with this
- License. However, in accepting such obligations, You may act only
- on Your own behalf and on Your sole responsibility, not on behalf
- of any other Contributor, and only if You agree to indemnify,
- defend, and hold each Contributor harmless for any liability
- incurred by, or claims asserted against, such Contributor by reason
- of your accepting any such warranty or additional liability.
-
View
@@ -1,30 +0,0 @@
-========================================
-Horizon: The OpenStack Dashboard Project
-========================================
-
-The Horizon project is a Django module that is used to provide web based
-interactions with an OpenStack cloud.
-
-There is a reference implementation that uses this module located at:
-
- http://launchpad.net/horizon
-
-It is highly recommended that you make use of this reference implementation
-so that changes you make can be visualized effectively and are consistent.
-Using this reference implementation as a development environment will greatly
-simplify development of the ``horizon`` module.
-
-Of course, if you are developing your own Django site using Horizon, then
-you can disregard this advice.
-
-
-Getting Started
-===============
-
-Horizon uses the common environment configured by ``tools/install_venv.py``
-based on the dependencies listed in ``tools/pip-requires`` for local
-development.
-
-The simplest way to get going is to simply run the ``run_tests.sh`` script
-included with the Horizon project. This will set up your local environment
-and run the full test suite to verify that everything is working properly.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Oops, something went wrong.

0 comments on commit 052aa55

Please sign in to comment.