Files
deb-python-osc-lib/doc/source/index.rst
Dean Troyer f78173f0e1 Rename to osc-lib
* add fresh README and doc tree
* remove references to OSC and commands
2016-05-12 16:06:15 -05:00

49 lines
1.5 KiB
ReStructuredText

=========================================
osc-lib -- OpenStackClient Plugin Library
=========================================
OpenStackClient (aka OSC) is a command-line client for OpenStack. osc-lib
is a package of common support modules for writing OSC plugins.
Contents:
.. toctree::
:maxdepth: 2
introduction
demoapp
list_commands
show_commands
complete
interactive_mode
classes
install
developers
history
Contributing
============
osc-lib utilizes all of the usual OpenStack processes and requirements for
contributions. The code is hosted `on OpenStack's Git server`_. `Bug reports`_
and `blueprints`_ may be submitted to the :code:`python-openstackclient` project
on `Launchpad`_. Code may be submitted to the
:code:`openstack/osc-lib` project using `Gerrit`_.
Developers may also be found in the `IRC channel`_ ``#openstack-sdks``.
.. _`on OpenStack's Git server`: https://git.openstack.org/cgit/openstack/python-openstackclient/tree
.. _Launchpad: https://launchpad.net/python-openstackclient
.. _Gerrit: http://docs.openstack.org/infra/manual/developers.html#development-workflow
.. _Bug reports: https://bugs.launchpad.net/python-openstackclient/+bugs
.. _blueprints: https://blueprints.launchpad.net/python-openstackclient
.. _PyPi: https://pypi.python.org/pypi/osc-lib
.. _tarball: http://tarballs.openstack.org/osc-lib
.. _IRC channel: https://wiki.openstack.org/wiki/IRC
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`