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.
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
The Autosubmit API have some configuration options that can be modified by setting their specific environment variable before starting the server:
PROTECTION_LEVEL: Default ALL. Possible values ALL, WRITEONLY, NONE.
ALL, all the endpoints will be protected by needing a valid token inside the Authorization header of the request.WRITEONLY, only a subset of the endpoints will be protected.NONE, none of the endpoints will be protected.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 and CAS_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 requiredpip install -e .[test]
pytest
pytest --cov=autosubmit_api --cov-config=.coveragerc --cov-report=html tests/
You will find the report in htmlcov/index.html
FAQs
An extension to the Autosubmit package that serves its information as an API
We found that autosubmit-api demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
PyPI confirms no security flaws were exploited in the Ultralytics supply chain attack and highlights improvements for safer package publishing.
Security News
Research
The Socket Research Team breaks down a malicious wrapper package that uses obfuscation to harvest credentials and exfiltrate sensitive data.
Research
Security News
Attackers used a malicious npm package typosquatting a popular ESLint plugin to steal sensitive data, execute commands, and exploit developer systems.