OpenStack Dashboard (Horizon)
Go to file
Takashi Kajinami fa29ed8e6d doc: Update setup file examples in the plugin tutorial
This commit updates the examples of setup.py and setup.cfg
to reflect the recent changes.

- Replace dashes by underscores in setup.cfg.
  Since setuptools v54.1.0[1], the parmeters with dash have been
  deprecated in favor of the new parameters with underscore.
- Update python versions in setup.cfg to match the current
  supported versions of python in OpenStack Yoga.
- Change the homepage URL in setup.cfg from horizon URL to a notice.
- Drop a workaround for python <2.7.4 in setup.py.
- Update the pbr requirement in setup.py
- Drop the unnecessary comment not to edit it
  as setup.py is not synced globally.

[1] https://github.com/pypa/setuptools/commit/a2e9ae4cb

Co-Authored-By: Akihiro Motoki <amotoki@gmail.com>
Change-Id: Id38299245f31d2db17fb1b74d60cf1232ee4a509
2022-02-08 22:53:25 +09:00
.zuul.d Create Keystone admin endpoint for horizon integartion job 2021-11-11 20:01:28 +05:30
doc doc: Update setup file examples in the plugin tutorial 2022-02-08 22:53:25 +09:00
horizon Imported Translations from Zanata 2021-10-07 07:16:58 +00:00
openstack_auth Merge "Use OPENSTACK_KEYSTONE_URL instead of HTTP_REFERRER" 2022-01-12 12:15:26 +00:00
openstack_dashboard Merge "Support RBAC security groups in dashboard" 2021-12-23 12:18:57 +00:00
playbooks Fix ironic-ui cross job 2020-09-10 06:10:38 +00:00
releasenotes Merge "Use OPENSTACK_KEYSTONE_URL instead of HTTP_REFERRER" 2022-01-12 12:15:26 +00:00
roles Improve integration tests logging 2020-09-04 12:46:17 +03:00
tools Fix coverage job 2020-10-05 15:32:06 +09:00
.eslintignore bump eslint version to 1.10.3 2016-03-31 14:06:45 +00:00
.eslintrc Update ESLint devDependencies in package.json 2020-12-16 12:20:10 -06:00
.gitignore [cleanup] Remove unused file refernce from .gitignore file 2020-12-08 08:57:46 +00:00
.gitreview OpenDev Migration Patch 2019-04-19 19:37:19 +00:00
.mailmap Update my mailmap 2013-10-25 14:49:23 +08:00
.pylintrc Use python3-style super() 2020-10-15 14:37:20 +09:00
CONTRIBUTING.rst [ussuri] [goal] Project PTL and contributor docs 2020-08-20 08:34:11 +09:00
HACKING.rst Update the documentation link for doc migration 2017-08-04 18:38:25 +00:00
LICENSE Initial commit 2011-01-12 13:43:31 -08:00
MANIFEST.in Update MANIFEST for dashboard config 2020-06-08 15:06:58 +02:00
README.rst Add release notes link in README 2018-07-10 14:45:26 +07:00
babel-django.cfg Drop babel extractor definitions from babel config 2019-12-23 17:25:38 +09:00
babel-djangojs.cfg Drop babel extractor definitions from babel config 2019-12-23 17:25:38 +09:00
bindep.txt Fix video recording for integration tests 2020-04-09 09:20:04 +00:00
lower-constraints.txt Allow both Django 2.2 and 3.2 for smooth transition 2021-10-26 09:57:06 +09:00
manage.py hacking: noqa cleanup in horizon 2017-03-17 19:38:47 +00:00
package.json Update devDependencies in package.json 2020-12-17 12:21:31 -06:00
plugin-registry.csv Remove retired karbor-dashboard usage 2020-12-15 16:04:11 -08:00
reno.yaml Tell reno to ignore the kilo branch 2020-03-23 13:18:58 +00:00
requirements.txt Allow both Django 2.2 and 3.2 for smooth transition 2021-10-26 09:57:06 +09:00
setup.cfg setup.cfg: Replace dashes with underscores 2021-04-27 14:10:15 +08:00
setup.py Updated from global requirements 2017-05-30 13:34:43 +00:00
test-requirements.txt Move linters dependencies to tox.ini 2021-03-19 11:25:28 +09:00
test-shim.js Add Apache 2.0 license to source file 2016-12-02 17:40:28 +07:00
tox.ini Preparation for Django 3.2 support 2021-09-16 16:43:17 +09: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.

image

Using Horizon

See doc/source/install/index.rst about how to install Horizon in your OpenStack setup. It describes the example steps and has pointers for more detailed settings and configurations.

It is also available at Installation Guide.

Getting Started for Developers

doc/source/quickstart.rst or Quickstart Guide describes how to setup Horizon development environment and start development.

Building Contributor Documentation

This documentation is written by contributors, for contributors.

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

To build the docs, use:

$ tox -e docs

Results are in the doc/build/html directory