summaryrefslogtreecommitdiff
path: root/doc/source
Commit message (Collapse)AuthorAgeFilesLines
...
* | Fixed a typo in SwiftService API docNandini Tata2016-06-011-1/+1
|/ | | | | | Fixed misspelled word in the Service API description. Change-Id: I0bb6b2aa319ba217dd0d09a2c7a0d8eff9a67aff
* Add new doc structure and contents for swiftclientJoel Wright2016-04-296-329/+976
| | | | | | | | | | | | | | | | | | | | As a result of the Hackathon we have produced a new documentation structure for the python-swiftclient. This patch introduces the new structure and adds the required content. The intention is to document the CLI, the SwiftService and Connection API. Importantly, we also provide guidance on important considerations when using a swift object store, such as which aspect of the python-swiftclient to use for various use cases, common authentication patterns and some useful examples. Co-Authored-By: Alexandra Settle <alexandra.settle@rackspace.com> Co-Authored-By: Mohit Motiani <mohit.motiani@intel.com> Co-Authored-By: Hisashi Osanai <osanai.hisashi@jp.fujitsu.com> Change-Id: I9eb41f8e9137efa66cead67dc264a76a3c03fbda
* Minor edits to the api pageAlexandra2016-02-291-66/+65
| | | | Change-Id: Ie65f73532e53a858ee9ab4b4634dcfcaf8a93c3b
* Merge "Update api docs title to make ToC better"Jenkins2016-02-241-3/+3
|\
| * Update api docs title to make ToC betterJohn Dickinson2016-02-221-3/+3
| | | | | | | | Change-Id: Ie8eeb3dd8eddf1868f0fa99911c459ae9f7b0091
* | New python swiftclient docAlexandra2016-02-103-0/+79
|/ | | | | | Updating with new ToC to be worked on at hackathon Change-Id: I55ee83626dd88fcc3e6352b3854b758dd7090590
* New API documentation for python-swiftclientJoel Wright2015-11-252-14/+744
| | | | | | | | New documentation for python-swiftclient that introduces the APIs available and gives some opinionated advice about when to use the shell, the client API and the service API. Change-Id: I19020f041fab2e72469979f712ffe3951c431d24
* enable autodocumentation for utils module; docstring fixesZack M. Davis2015-09-101-0/+5
| | | | | | | | | | | | | | This commit adds the utils module to those for which Sphinx automatically generates documentation from docstrings. (Many of the functions here may be of little interest to users, but `generate_temp_url`, at least, definitely deserves to be in the documentation; in this way, this commit can be seen as a spiritual companion to ca70dd9e.) Also, a few markup errors and perceived infelicities in existing docstrings are amended. Change-Id: I8c66a23cb359d7dd9302a16459fad9825fedb690
* Add importable SwiftService incorporating shell.py logicJoel Wright2014-08-261-0/+5
| | | | | | | | | | | | | | | | This patch adds a SwiftService class that incorporates the high level logic from swiftclient/shell.py. It also ports shell.py to use the new class, and updates the code in swiftclient/multithreading.py to allow the SwiftService to be used for multiple operations whilst using only one thread pool. Currently, code that imports swiftclient has to have its own logic for things like creating large objects, parallel uploads, and parallel downloads. This patch adds a SwiftService class that makes that functionality available in Python code as well as through the shell. Change-Id: I08c5796b4c01001d79fd571651c3017c16462ffd Implements: blueprint bin-swift-logic-as-importable-library
* Update theme for docsSteve Martinelli2014-07-242-2/+2
| | | | | | | | The current developer docs theme used is out of sync with the other openstack projects. This patch will update the docs to provide a more consistent look and feel when using developer docs Change-Id: I2c66f60f6cfdd7b7b50a457c931f11851f668fa6
* fixed several pep8 issuesChristian Berendt2014-05-211-34/+34
| | | | | | | | | | | * E111 indentation is not a multiple of four * E128 continuation line under-indented for visual indent * E265 block comment should start with '# ' * E713 test for membership should be 'not in' Tested with pep8 version 1.5.6 (2014-04-14). Change-Id: I7f85c143d463c501a0df20724362ad5c0f2d4dde
* Make pbr only a build-time dependency.Samuel Merritt2013-10-101-3/+3
| | | | | | | | | | | | | | This lets you build python-swiftclient packages that don't require pbr to be installed at all. You would need pbr on the machine running rpmbuild / debuild, but not on the machines that install the packages. Unfortunately, this does not make python-swiftclient able to be installed via pip 0.3.1 on Lucid; you'll need to uninstall the system python-pip package and install a new pip some other way. Given that pip < 1.3 doesn't perform SSL certificate validation for pypi (trivial MITM attack, anyone?), you'd probably want to get a new pip anyway. Change-Id: I85d4d77aacf094e48d39e48e750594b95dbc7af0
* Move multi-threading code to a library.Darrell Bishop2013-07-282-9/+14
| | | | | | | | | | | | | | | | | | | | | | This patch extracts the multi-threading code from bin/swift into swiftclient/multithreading and adds tests. In particular, this new way of doing it (with context managers) will prevent non-daemonic threads from wedging the process when unexpected exceptions happen. I enabled reporting of which lines, specifically, are not covered by unit tests (added -m option to "coverage report" in .unittests). This patch includes a drive-by fix for uploading a segmented file with --use-slo when that object already exists. A key of "name" was used instead of "path", raising KeyError. There's also another drive-by fix for uploading segmented objects with --use-slo. Commit 874e0e4427b80e1b15b74a1557b73ba9d61443ca regressed this by removing the capturing of thread-worker results in QueueFunctionThread.run(). This patch restores that functionality and the feature (uploading SLO objects). Change-Id: I0b4f677e4a734e83d1a25088d9a74f7d46384e53
* Allow storage url override for both auth vers.Darrell Bishop2013-07-051-1/+1
| | | | | | | | | | | | | | | | | | | | When --os-storage-url is specified on the command-line to bin/swift, it will override the used storage URL regardless of authentication for both authentication version 1 and version 2. This can be used to bypass a load-balancer to hit a specific proxy server for testing/debugging purposes. Within the client library, this feature is accessed by passing the desired storage URL into swiftclient.client.Conection.__init__() via the os_options keyword argument. For example: conn = Connection(auth_url, user, key, os_options={ 'object_storage_url': 'http://overridden.storage.url/AUTH_foo'}) This patch also adds a dependency on mock>=0.8.0, which is the same as openstack/swift. Change-Id: Id2a36ed6abffd65e7762b6beea5bbfc6c036e848
* Update to latest oslo version/setup.Monty Taylor2013-01-141-3/+1
| | | | Change-Id: I7bd38b950ef9fea8b6eaa1df599085a1c64d8b61
* PEP8 issues fixedRay Chen2012-08-291-3/+5
| | | | | | | 1. Have a better indent in doc/source/conf.py 2. Fix an import issue Change-Id: I5811c195157706d2a85c0fd47666e67f94b2c558
* Fix PEP8 issues.lrqrun2012-08-281-1/+2
| | | | | | Fix some pep8 issues in doc/source/conf.py make the code looks pretty. Change-Id: Icc5ce260aaae8a2c436f5146840ffde4e6ef2839
* Merge "Removes the title "Swift Web" from landing page."Jenkins2012-07-161-1/+1
|\
| * Removes the title "Swift Web" from landing page.annegentle2012-07-051-1/+1
| | | | | | | | | | | | Also want to test the DocImpact flag for notifications. Change-Id: I4e12d76050720bec5126db3c87391dbbe54773a2
* | Consume version info from pkg_resources.Clark Boylan2012-07-111-3/+4
|/ | | | | | | | | | | | | | Documenation builds specify a version in doc/source/conf.py that is used in appropriate places through out the documentation. Previously this value had not been defined properly and documentation builds failed. Retrieve the version info using pkg_resources and set it properly. Use openstack.common.version to consume the generated version information for documentation. Additional, add a swiftclient.__version__ member which will return the version of swiftclient being used. Change-Id: I14f3abdf00da3f9ea7d0651efe76b08f69ddabae
* Add build_sphinx options.Clark Boylan2012-06-111-1/+8
| | | | | | | | | To better facilitate the building and publishing of sphinx documentation by Jenkins we are moving all openstack projects with sphinx documentation to a common doc tree structure. Documentation goes in project/doc/source and build results go in project/doc/build. Change-Id: Ibe6745cac73817ea06faca77367b4269d5137a24
* Add doc and version in swiftclient.__init__.pyChmouel Boudjnah2012-06-075-0/+246
- Add parseable version in swiftclient.__init.py - Generate rst doc like done for swift. Change-Id: I408fbc36693772d2ef6f4823757dd1f4c830193f
View Lorry Controller Status