92274d4790
Add an other-requirements.txt file containing a cross-platform list of dependencies needed for running included tox-based tests. Also include a tox environment for convenience calling the bindep[*] utility to list any missing system requirements. Document bindep and other-requirements usage. This change is self-testing. For other-requirements.txt see also http://docs.openstack.org/infra/manual/drivers.html#package-requirements [*] http://docs.openstack.org/infra/bindep/ Change-Id: Iea6f5fecba3b7cb9f6dac7029c0f17fc31fc0e3c
52 lines
1.7 KiB
ReStructuredText
52 lines
1.7 KiB
ReStructuredText
===============
|
|
Getting Started
|
|
===============
|
|
|
|
-------------------
|
|
System Requirements
|
|
-------------------
|
|
|
|
Swift development currently targets Ubuntu Server 14.04, but should work on
|
|
most Linux platforms.
|
|
|
|
Swift is written in Python and has these dependencies:
|
|
|
|
* Python 2.7
|
|
* rsync 3.0
|
|
* The Python packages listed in `the requirements file <https://github.com/openstack/swift/blob/master/requirements.txt>`_
|
|
* Testing additionally requires `the test dependencies <https://github.com/openstack/swift/blob/master/test-requirements.txt>`_
|
|
* Testing requires `these distribution packages <https://github.com/openstack/swift/blob/master/other-requirements.txt>`_
|
|
|
|
There is no current support for Python 3.
|
|
|
|
-----------
|
|
Development
|
|
-----------
|
|
|
|
To get started with development with Swift, or to just play around, the
|
|
following docs will be useful:
|
|
|
|
* :doc:`Swift All in One <development_saio>` - Set up a VM with Swift installed
|
|
* :doc:`Development Guidelines <development_guidelines>`
|
|
* :doc:`First Contribution to Swift <first_contribution_swift>`
|
|
* :doc:`Associated Projects <associated_projects>`
|
|
|
|
--------------------------
|
|
CLI client and SDK library
|
|
--------------------------
|
|
|
|
There are many clients in the `ecosystem <http://docs.openstack.org/developer/swift/associated_projects.html#application-bindings>`_. The official CLI
|
|
and SDK is python-swiftclient.
|
|
|
|
* `Source code <https://github.com/openstack/python-swiftclient>`_
|
|
* `Python Package Index <https://pypi.python.org/pypi/python-swiftclient>`_
|
|
|
|
----------
|
|
Production
|
|
----------
|
|
|
|
If you want to set up and configure Swift for a production cluster, the
|
|
following doc should be useful:
|
|
|
|
* :doc:`Multiple Server Swift Installation <howto_installmultinode>`
|