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.
Install via PYPI
pip install fandango-aria-plugin
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
Connections are configured in the config.yml
file located within the fandango/config
package.
Here, you will be required to complete the following:
- Login URL
- Note: You will need slgihtly different URLS for BETA/LOCAL token retrieval
- Client Secret
- Client ID
- Session Key
- Facility ID
- Local Data Deopsition Base
- Local Entity Base
- Beta Data Deopsition Base
- Beta Entity Base
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
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