An extension to the Autosubmit package that serves its information as an API
Project description
Autosubmit API
Table of Contents
Overview
Autosubmit API is a package that consumes the information generated by Autosubmit and serves it as an API.
Distribution: https://pypi.org/project/autosubmit-api/
See the openapi.json
specification and the repository wiki for more information.
Installation
Autosubmit API can be easily installed via pip
pip install autosubmit-api # >=4.0 (recommended)
# Check installation and serving options
autosubmit_api start -h
Start the server:
autosubmit_api start
Configuration options
The Autosubmit API have some configuration options that can be modified by setting their specific environment variable before starting the server:
PROTECTION_LEVEL
: DefaultALL
. Possible valuesALL
,WRITEONLY
,NONE
.- If set to
ALL
, all the endpoints will be protected by needing a valid token inside theAuthorization
header of the request. - If set to
WRITEONLY
, only a subset of the endpoints will be protected. - If set to
NONE
, none of the endpoints will be protected.
- If set to
SECRET_KEY
: The secret key to encode the JWT tokens from the Authorization Module. Important to be set up on production.CAS_SERVER_URL
: CAS Protocol server base URL to request a ticket and verify it. Used for/v4
endpoints.CAS_LOGIN_URL
andCAS_VERIFY_URL
can be empty if this variable is set (the API will append the protocol URL subpaths).CAS_LOGIN_URL
: CAS Protocol URL to request a ticket. Used for/v3
endpoints.CAS_VERIFY_URL
: CAS Protocol URL to verify a given ticket. Used for/v3
endpoints.GITHUB_OAUTH_CLIENT_ID
: Client ID of the Github Oauth app.GITHUB_OAUTH_CLIENT_SECRET
: Secret key of the Github Oauth app.GITHUB_OAUTH_WHITELIST_ORGANIZATION
: Used to use authorization based on the membership of a Github organization.GITHUB_OAUTH_WHITELIST_TEAM
: Used to use authorization based on the membership of a Github team in an organization.GITHUB_OAUTH_WHITELIST_ORGANIZATION
is required
How to run tests
Install pytest
pip install -e .[test]
Run tests:
pytest
Run tests with coverage HTML report:
pytest --cov=autosubmit_api --cov-config=.coveragerc --cov-report=html tests/
You will find the report in htmlcov/index.html
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
autosubmit_api-4.0.0b7.tar.gz
(148.2 kB
view hashes)
Built Distribution
Close
Hashes for autosubmit_api-4.0.0b7-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7ee47c79f9beb85fe06edfb4f9d4d78bc2e49b595d8979192d4de44894932ae4 |
|
MD5 | 58d41c910c2f77a1e30cf259b946ace6 |
|
BLAKE2b-256 | f26ceadd4501f9d723b2d20c4e03b35adcab92e49a719c7ce9d4f557975b3fbc |