A collection of scripts to easily use the API of OCD Datalake
Project description
____ _ _ _ ____ _ _
| _ \ __ _| |_ __ _| | __ _| | _____ / ___| ___ _ __(_)_ __ | |_ ___
| | | |/ _` | __/ _` | |/ _` | |/ / _ \ \___ \ / __| '__| | '_ \| __/ __|
| |_| | (_| | || (_| | | (_| | < __/ ___) | (__| | | | |_) | |_\__ \
|____/ \__,_|\__\__,_|_|\__,_|_|\_\___| |____/ \___|_| |_| .__/ \__|___/
|_|
datalake
Datalake scripts
How to use
Installation
With Python 3.6+:
$ pip install datalake-scripts
$ pip3 install datalake-scripts
Using as a library
Using as a CLI
The cli can be used with:
$ ocd-dtl <command> <parameter>
Check ocd-dtl -h
for help, including the list of commands available.
You can also use a script directly by using the following command: <script_name> <script_options>
.
/!\ Make sure to use utf-8 without BOM when providing a file (-i option)
Environment variables
Authentication
In case you don't want to enter credential for each commands and you are on a secured terminal, set those variables:
OCD_DTL_USERNAME
email address used to login on Datalake API/GUI.OCD_DTL_PASSWORD
password used to login on Datalake API/GUI.
They are independent and one can be used without the other if you wish.
Throttling
For throttling the request, those two environment variable can be used:
OCD_DTL_QUOTA_TIME
define, in seconds, the time before resetting the requests limit, default is 1 second.OCD_DTL_REQUESTS_PER_QUOTA_TIME
define the number of request to do at maximum for the given time, default is 5 queries.
Please don't exceed the quota marked here for each endpoint
Cli parameters
Parameters common and optional for all commands:
--debug display more information for debugging purposes
-e to change the environment {preprod, prod}, default is prod
-o will set the output file as the API gives it.
-q will quiet the verbosity of the program (but still show errors / warnings)
For information about each command and more, please check the documentation directory
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
Built Distribution
Hashes for datalake_scripts-2.5.7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f880c868c513b032b6bc69976294371693108838540f0418e4e5f61db9eb36ad |
|
MD5 | 92c31c3686569324f950d6df76d5db11 |
|
BLAKE2b-256 | 693ccdbf9e4a3f4bc93cb2a7027af2b9e0373eef2a98edffa3115bc618345280 |