Archivematica API client library.
Project description
amclient
The transfers/amclient.py script is a module and CLI that provides functionality for interacting with the various Archivematica APIs.
Basic usage:
amclient.py <subcommand> [optional arguments] <positional argument(s)>
E.g.:
amclient.py close-completed-transfers \
--am-user-name test 234deffdf89d887a7023546e6bc0031167cedf6
To see a list of all commands and how they are used, then run amclient.py
without any arguments.
To understand how to use an individual subcommand, simply run:
amclient.py <subcommand>
, the output will describe the input parameters for
that command:
E.g.:
usage: amclient extract-file [-h] [--ss-user-name USERNAME] [--ss-url URL]
[--directory DIR]
[--saveas-filename SAVEASFILENAME]
ss_api_key package_uuid relative_path
Calling the module from Python:
E.g.:
Python 3.6.7 (default, Oct 22 2018, 11:32:17)
[GCC 8.2.0] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from amclient import AMClient
>>> am = AMClient()
>>> am.ss_url = "http://127.0.0.1:62081"
>>> am.ss_user_name = "test"
>>> am.ss_api_key = "test"
>>> am.list_storage_locations()
...json is output here...
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
amclient-1.0.0rc4.tar.gz
(12.9 kB
view hashes)
Built Distribution
Close
Hashes for amclient-1.0.0rc4-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 65fdfbd8c8671c8f933bbfc5577fa28ec03c6ae93e9a573b6e5f061509391dfd |
|
MD5 | 524a26b6aae0234db8cdbf92b01597e5 |
|
BLAKE2b-256 | 5e50d1434d4b8fdf6904557c91ee80e42b4e3d4f9de15a45f73af54f96917b7c |