swift/doc/source/getting_started.rst

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
• Testing additionally requires the test dependencies

There is no current support for Python 3.

Getting Swift

Swift's source code is hosted on github and managed with git. The current trunk can be checked out like this:

git clone https://github.com/openstack/swift.git

A source tarball for the latest release of Swift is available on the launchpad project page.

Prebuilt packages for Ubuntu and RHEL variants are available.

• Swift Ubuntu Packages
• Swift RDO Packages

Development

To get started with development with Swift, or to just play around, the following docs will be useful:

• Swift All in One <development_saio> - Set up a VM with Swift installed
• Development Guidelines <development_guidelines>
• Associated Projects <associated_projects>

CLI client and SDK library

There are many clients in the ecosystem. The official CLI and SDK is python-swiftclient.

• Source code
• Python Package Index

Production

If you want to set up and configure Swift for a production cluster, the following doc should be useful:

• Multiple Server Swift Installation <howto_installmultinode>