Skip to main content

Autosubmit API

codecov PyPI - Downloads GitHub Actions Workflow Status

Table of Contents

  1. Overview
  2. Installation
  3. Configuration options
  4. How to run tests

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/

Full documentation: https://autosubmit-api.readthedocs.io/

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. Here are some options:

  • SECRET_KEY: The secret key to encode the JWT tokens from the Authorization Module. Important to be set up on production.
  • AS_API_ROOT_PATH: The root path of the API. This is useful if you are serving it with a reverse proxy. Default is an empty string.

To see the full list go to: https://autosubmit-api.readthedocs.io/en/latest/configuration/

How to run tests

Install pytest

pip install -e .[test]

Run tests:

pytest

You will find the coverage report in htmlcov/index.html

Metadata

Release files for autosubmit-api 4.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for autosubmit-api 4.2.0
File Size Uploaded
autosubmit_api-4.2.0.tar.gz 209.3 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for autosubmit-api 4.2.0
File Interpreter ABI Platform
autosubmit_api-4.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 484.3 kB

Release files / autosubmit_api-4.2.0.tar.gz

Download URL autosubmit_api-4.2.0.tar.gz
Size 209.3 kB
Tags Source
SHA-256 checksum
How to use checksums
831c0168df619ac85e4b11e657dd681a2edbcdcdd8f9f154ef34072913a9c1e9
BLAKE2b-256 checksum
How to use checksums
5363d31a6cf4a2ffbd75159c61a6d14f0d0bfdf5a851a3596f54ad95dbcd32dc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 28, 2026.

Transparency log

Release files / autosubmit_api-4.2.0-py3-none-any.whl

Download URL autosubmit_api-4.2.0-py3-none-any.whl
Size 275.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
618683cc843c4f8309dfd48372c15289acda5b188e3b2eae22bac868f781209d
BLAKE2b-256 checksum
How to use checksums
261afd37143c75b25714f45b9f8fb83cfa3449e0e7830c0d4de653f51ad79115
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Sep 28, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

4.2.0 This release

2 release files

4.1.2

2 release files

4.1.1

2 release files

4.1.0

2 release files

4.0.1

2 release files

4.0.0

2 release files

3.7.0

2 release files

3.1.0

2 release files

2.1.0

2 release files

2.0.0

2 release files

1.7.0

2 release files

1.0.30

2 release files

1.0.28

2 release files

1.0.27

2 release files

1.0.22

2 release files

1.0.21

2 release files

1.0.20

2 release files

1.0.18

2 release files

1.0.10

2 release files

1.0.9

2 release files

1.0.8

2 release files

1.0.7

2 release files

1.0.6

2 release files

1.0.5

2 release files

1.0.4

2 release files

1.0.3

2 release files

1.0.2

2 release files

1.0.1

2 release files

1.0.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page