Skip to main content

Authentication library for amazing Python requests library against NPAW Youbora API.

Project description

## PyYoubora

Authentication library and wrapper for NPAW Youbora API.

This module contains:
- `YouboraAuth` - custom authorisation provider for Python Requests, check `example_auth.py`
- `YouboraClient` - Wrapper which utilises Swagger definition to validate requests
against NPAW Youbora before executing Request, check `example_client.py`

## Getting started:
- check out included `example_auth.py` and `example_client.py`
- but, basically this gives you:

```python
import requests
from youbora import YouboraAuth

query = {}

response = requests.get('https://api.youbora.com/:system_code:/data',
params=query,
auth=YouboraAuth("secret", "system_code")
```

## Future considerations (wish list):
- to extend library with _helpers_ such as:
- More Swagger API validations;
- Youbora Query Builder, interactive perhaps ?
- Youbora Filter Builder, interactive perhaps ?
- Response formatter for quick report/graph generations in various formats

## Good to know
- as Youbora Swagger definition is available only via closed access Developers portal,
it is not included in this repository in order to respect NPAW approach to their documentation.
- This code base (examples and config-sample.py) assumes that swagger is available within base directory as swagger.json
- both example_x.py assumes that you have copied config-sample.py to config.py and have provided details there.
- you can very easy use any other config approach - sysarg, env, AWS KMS, etc.

Project details


Release history Release notifications | RSS feed

This version

0.2

Download files

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

Source Distribution

PyYoubora-0.2.tar.gz (15.9 kB view details)

Uploaded Source

Built Distribution

PyYoubora-0.2-py2-none-any.whl (4.0 kB view details)

Uploaded Python 2

File details

Details for the file PyYoubora-0.2.tar.gz.

File metadata

  • Download URL: PyYoubora-0.2.tar.gz
  • Upload date:
  • Size: 15.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/2.7.10

File hashes

Hashes for PyYoubora-0.2.tar.gz
Algorithm Hash digest
SHA256 c7f01b3f520261b3e6a24eff8147adb80368c3d8a9b681bf0d4166b45d6493c8
MD5 28d6ecda500d8b0bb081880261aa4a59
BLAKE2b-256 2922b7c0e4279d58633919725b9d29f6e203b6742e6c85dfbd2e1bd39158e4f0

See more details on using hashes here.

File details

Details for the file PyYoubora-0.2-py2-none-any.whl.

File metadata

  • Download URL: PyYoubora-0.2-py2-none-any.whl
  • Upload date:
  • Size: 4.0 kB
  • Tags: Python 2
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.11.0 pkginfo/1.4.2 requests/2.19.1 setuptools/40.0.0 requests-toolbelt/0.8.0 tqdm/4.24.0 CPython/2.7.10

File hashes

Hashes for PyYoubora-0.2-py2-none-any.whl
Algorithm Hash digest
SHA256 bf13bc908dd2ec1d3f0fd19aa8fcd17b5bd17709e604831a4f882e6da1acc305
MD5 3970babd840f79e299604e58332f2d31
BLAKE2b-256 32934c7293a1e7e3c0e6366b4fbb7b32c309d7ab9f278b1ba2a3f226c2ac590b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page