fmu-settings-api
fmu-settings-api is the FastAPI backend for the fmu-settings application.
Usage
This application is primarily invoked by
fmu-settings-cli and is meant
to be used together with
fmu-settings-gui. It depends
mostly on fmu-settings to work with
.fmu/ configuration directories within the FMU context.
With fmu-settings-cli installed, to run the API by itself just
fmu settings api
An authorization token is required to create a session. When developing you can print this token to the the terminal with
fmu settings api --print-token
It's useful to be able to reload while developing.
fmu settings api --print-token --reload
API Documentation
The routes have documentation on them. To view them, and work with the API go
to localhost:8000/docs (or whatever your port may end up being).
Configuration
Configuration should largely be handled by the GUI when they are being run
together. When developing you will want to be able to access different
endpoints. You can configure some of these values with .env and scripts in
the scripts/ directory.
A sample.env is included here. To get your own SMDA subscription
key you may go to the internal Equinor API self-service website. Copy
sample.env to .env and fill in the correct values.
Access token
Accessing services through this API requires a valid access token. You can
acquire one with the scripts/get_token.py script. This
script will open a small server, authenticate you with SSO, and store your
access token to .token. You may then use this as you need.
Developing
Clone and install into a virtual environment.
git clone git@github.com:equinor/fmu-settings-api.git
cd fmu-settings-api
# Create or source virtual/Komodo env
pip install -U pip
pip install -e ".[dev]"
# Make a feature branch for your changes
git checkout -b some-feature-branch
Run the tests with
pytest -n auto tests
Ensure your changes will pass the various linters before making a pull request. It is expected that all code will be typed and validated with mypy.
ruff check
ruff format --check
mypy src tests
See the contributing document for more.
3 maintainers
Metadata
3 maintainers
Release files for fmu-settings-api 1.5.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| fmu_settings_api-1.5.3.tar.gz | 274.1 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| fmu_settings_api-1.5.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 368.4 kB
Release files / fmu_settings_api-1.5.3.tar.gz
| Download URL | fmu_settings_api-1.5.3.tar.gz |
|---|---|
| Size | 274.1 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1e19fb5663125fcc64ac51f313994b589c18675bbfe9fc752a5b861d04390da6
|
|
BLAKE2b-256 checksum How to use checksums |
fac294dee948594c05b20f19db7916de8c0fc97be607401607a98c2b1773b40e
|
| 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 26, 2026.
Transparency logRelease files / fmu_settings_api-1.5.3-py3-none-any.whl
| Download URL | fmu_settings_api-1.5.3-py3-none-any.whl |
|---|---|
| Size | 94.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1bcc5fdc55c887d0ffc6048b98915d0753d8f550c039a56e0b11c5a140d2e526
|
|
BLAKE2b-256 checksum How to use checksums |
4f9f3a29e7fe423729d9e19d792c3203e4316c4aa2b54b724dd732278d71f7f5
|
| 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 26, 2026.
Transparency log
