Skip to content

Latest commit

 

History

History
86 lines (48 loc) · 2.84 KB

README.md

File metadata and controls

86 lines (48 loc) · 2.84 KB
Raw
Alt text

fandanGO-aria

Python

Connect on LinkedIn GitHub issues GitHub forks GitHub contributors PyPI version License Documentation

Intro

Welcome to the fandanGO-aria package.

This package acts as a broker for ARIA's metadata deposition REST endpoints.

Please refer to our Wiki for full documentation.

Installation

Install via PYPI

pip install fandanGO-aria

Setup

Connections are configured in the .env file located in the root of your project.

Here, you will be required to complete the following:

All Connections

  • Login URL
    • Note: You will need slgihtly different URLS for BETA/LOCAL token retrieval
  • Client Secret
  • Client ID
  • Grant Type
  • Scope
  • Session Key
  • Facility ID

Caveats

The following env options are not neccessary and are mostly used for development :

  • Email : If a CLI user, this will remove the need to re-enter your login email
  • Password : Similar to Email. Use with caution if on a communal computer.
  • Username

Post Setup

If you've successfully completed the above setup options, you're ready to start using the package.

Note

This package uses Keyring to store token information securely. Keyring is usable accross multiple os and supports the following backends:

  • macOS Keychain
  • Freedesktop Secret Service supports many DE including GNOME (requires secretstorage)
  • KDE4 & KDE5 KWallet (requires dbus)
  • Windows Credential Locker

Linux

If problems arise when storing tokens on a Linux device, it may be required to download dbus-python.

Please use the dbus package to solve the issue