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

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.1.1.tar.gz (153.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

autosubmit_api-4.1.1-py3-none-any.whl (204.2 kB view details)

Uploaded Python 3

File details

Details for the file autosubmit_api-4.1.1.tar.gz.

File metadata

  • Download URL: autosubmit_api-4.1.1.tar.gz
  • Upload date:
  • Size: 153.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for autosubmit_api-4.1.1.tar.gz
Algorithm Hash digest
SHA256 9c604628d4b8990efeadae7e36ced5e8365caae332263ebfb63fdcc500aa7cc4
MD5 81ce600e14ccd345d8a499f4860e5d18
BLAKE2b-256 4374b2392b9821ba49dac65644464d089329141ad5bb40e7c616adfa4dace521

See more details on using hashes here.

Provenance

The following attestation bundles were made for autosubmit_api-4.1.1.tar.gz:

Publisher: publish.yml on BSC-ES/autosubmit-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file autosubmit_api-4.1.1-py3-none-any.whl.

File metadata

  • Download URL: autosubmit_api-4.1.1-py3-none-any.whl
  • Upload date:
  • Size: 204.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for autosubmit_api-4.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 33de63e5990d17d5c694ea2bda42e1b69ab0bf0e5122228eb72a57ac8f8daa0d
MD5 2be22340fc1a808149e9bc74a2a445df
BLAKE2b-256 e190bc4040217932129e6951018bb9ef79b6b6fb1992117e93d6c8f418d925cf

See more details on using hashes here.

Provenance

The following attestation bundles were made for autosubmit_api-4.1.1-py3-none-any.whl:

Publisher: publish.yml on BSC-ES/autosubmit-api

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

4.1.1 This release

2 files

4.1.0

2 files

4.0.1

2 files

4.0.1b1

2 files

4.0.0

2 files

3.7.0

2 files

3.1.0

2 files

2.1.0

2 files

2.0.0

2 files

1.7.0

2 files

1.0.30

2 files

1.0.28

2 files

1.0.27

2 files

1.0.26

2 files

1.0.24

2 files

1.0.22

2 files

1.0.21

2 files

1.0.20

2 files

1.0.18

2 files

1.0.17

2 files

1.0.16

2 files

1.0.15

2 files

1.0.13

2 files

1.0.12

2 files

1.0.11

2 files

1.0.10

2 files

1.0.9

2 files

1.0.8

2 files

1.0.7

2 files

1.0.6

2 files

1.0.5

2 files

1.0.4

2 files

1.0.3

2 files

1.0.2

2 files

1.0.1

2 files

1.0.0

2 files

Supported by

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