A Public Client library and CLI for interacting with ARIA's Data Deposition Service.
Project description
FandanGO : Aria Plugin
Intro
Welcome to the FandanGO ARIA plugin.
This package acts as a broker for ARIA's data deposition REST endpoints.
Please refer to our Wiki for full documentation.
Installation
Install via PYPI
pip install fandango-aria-plugin
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
Setup
Connections are configured in the config.yml
file located within the fandango/config
package.
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
- Session Key
- Facility ID
Local Connections
- Local Data Deopsition Base
- Local Entity Base
Beta Connections
- Beta Data Deopsition Base
- Beta Entity Base
Caveats
The following config 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.
If at any point you need to switch between Local and Beta databases, switch the DEV
value between LOCAL
and BETA
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file fandango_aria_plugin-1.0.3.tar.gz
.
File metadata
- Download URL: fandango_aria_plugin-1.0.3.tar.gz
- Upload date:
- Size: 17.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 15cdba2ae9bf13ed3c8db9ac5e5bdfc3436dca312e1e0b2cd2ba4ad168368d54 |
|
MD5 | 96b47ec46f06b6b5752f63534a1768eb |
|
BLAKE2b-256 | 10aec64dc42932306a5ee14ab948d443287c3d5686258a00f4d2364d249c0cd7 |
File details
Details for the file fandango_aria_plugin-1.0.3-py3-none-any.whl
.
File metadata
- Download URL: fandango_aria_plugin-1.0.3-py3-none-any.whl
- Upload date:
- Size: 23.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.6
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0580fef5b3231942bae630d3016bdb808aab1eab894dcdd1c5c9e2e478174e6 |
|
MD5 | 9a28c470caa204c772e3bfe690b1f8f0 |
|
BLAKE2b-256 | ddce3c1fe0d341dd36236465ecb267946a90d81e5231c7490a24c8dba3f6e953 |