summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Add help message for "<subcommand> --help"Hirokazu Sakata2015-02-101-1/+1
| | | | | | | | | This patch fixed help message for "<subcommand> --help" in general help message. Previous help message was only "this help message". It has not described for subcommand. Change-Id: I2fe6413baf98ba3881425ee6bed29c618e29fff8 Closes-Bug: 1420253
* 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
* swift.1 manpage fix for groff warningsThomas Goirand2014-02-181-17/+17
| | | | | | | | | | | | | | The current manual page contains hyphens where a minus sign was intended. By default, "-" chars are interpreted as hyphens (U+2010) by groff, not as minus signs (U+002D). Since options to programs use minus signs (U+002D), this means for example in UTF-8 locales that you cannot cut and paste options, nor search for them easily. This patch fixes this by escaping hyphens with backslashes, and also fixes a typo: s/retreived/retrieved/. Change-Id: If954c91eebe7b39bdac792f1f126998d2e3bcb8e
* Add capabilities optionFabien Boucher2014-01-171-2/+8
| | | | | | | | This patch adds a capabilities option on swiftclient. This option uses the new /info endpoint to request the remote capabilities and nicely display it. Change-Id: Ie34b454511d5527e402e66e1fdb72120f427f2fd
* Add --object-nameTaurus Cheung2013-12-241-1/+3
| | | | | | | | | Add parameter --object-name, which: 1) Sets target object name when upload single file 2) Sets object prefix when upload a directory Change-Id: Idc4357c3355e66d31c100540b901e70db20b03c3 Closes-Bug: 1012979
* Allow custom headers when using swift download (CLI)Matthieu Huin2013-11-041-0/+2
| | | | | | | | | | This fixes bug #1051046 A repeatable option, --header or -H, is added so a user can specify custom headers such as Range or If-Modified-Since when downloading an object with the swift CLI. Change-Id: I1f7dcf64cf625f2e5a4488c210894cfe6e0d5974
* Replaced two references to Cloud Files with SwiftAlex Gaynor2013-11-011-1/+1
| | | | Change-Id: I721f2b25a255a829c625b34928b066df3cd3e632
* 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-052-1/+2
| | | | | | | | | | | | | | | | | | | | 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
* Add -l and --lh switches to swift 'list' commandMark Seger2013-06-101-0/+5
| | | | | | | Also updated man page and added an example in 'list' command help message Change-Id: Icf38de9bab6d387a9a1deed444a91f68b4389cfe
* Update the man pagePete Zaitcev2013-05-211-34/+32
| | | | | | | | | | - Add -V option - Use uniform and correct capitalization for OpenStack Swift - Make the example of output of stat command up-to-date - Generally prettify the document - Remove all trailing whitespace Change-Id: Id3da2035851847c4bff8cec8f927d3654824bf5b
* Add client man page swift.1Pete Zaitcev2013-02-261-0/+128
| | | | | | | | | | This is the byte-by-byte copy of swift.1 that was left behind in the main Swift package when python-swiftclient was split away. Apparently there is absolutely nothing to be changed in setup.py and the distribution packagers are supposed to pick the page as-is using their packaging systems. Change-Id: I24f238501589db940574eac61b89a1422fe2fd77
* 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-112-1/+98
| | | | | | | | | 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