Metadata-Version: 2.4
Name: fmu-settings-gui
Version: 0.0.1
Summary: The GUI for fmu-settings
Author-email: Equinor <fg-fmu_atlas@equinor.com>
License: GPL-3.0
Project-URL: Homepage, https://github.com/equinor/fmu-settings-gui
Project-URL: Repository, https://github.com/equinor/fmu-settings-gui
Project-URL: Documentation, https://github.com/equinor/fmu-settings-gui
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Utilities
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Natural Language :: English
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: fastapi
Requires-Dist: uvicorn
Provides-Extra: dev
Requires-Dist: mypy; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: pytest-mock; extra == "dev"
Requires-Dist: pytest-xdist; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: types-setuptools; extra == "dev"
Dynamic: license-file

# fmu-settings-gui

[![ci](https://github.com/equinor/fmu-settings-gui/actions/workflows/ci.yml/badge.svg)](https://github.com/equinor/fmu-settings-gui/actions/workflows/ci.yml)

**fmu-settings-gui** is the web frontend for fmu-settings. There are two parts to this
repo:
- The code for the React application, located in the `frontend` directory. This is the
  main application, containing the web frontend
- The code for the Python application, located in the root and in the `src` directory.
  This serves the built and deployed React application


## Python application

Doing a local pip install will attempt to build the React application behind
the scenes. This requires a few dependencies (Node, pnpm, ..) that are not
installable via pip. View the [frontend README](/frontend/README.md) for
instructions.

Be sure to include a verbose flag or two (`pip install . -vv`) if you need to
observe the frontend installation output.

### Developing

Clone and install into a virtual environment.

```sh
git clone git@github.com:equinor/fmu-settings-gui.git
cd fmu-settings-gui
# 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

```sh
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.

```sh
ruff check
ruff format --check
mypy src tests
```

See the [contributing document](CONTRIBUTING.md) for more.


## React application

See the application's [README](frontend/README.md) file for information.
