Skip to main content

Archivematica API client library.

Project description

Travis CI

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for amclient, version 1.0.0rc4
Filename, size File type Python version Upload date Hashes
Filename, size amclient-1.0.0rc4-py2.py3-none-any.whl (27.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size amclient-1.0.0rc4.tar.gz (12.9 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page