Skip to content

About

Common implicit build dependencies for the IDSS Engine Project

Resources

Stars

0 stars

Watchers

3 watching

Forks

Repository files navigation

IDSS Engine Commons

Pytest Lint with pylint

Coverage

Coverage Report
FileStmtsMissCoverMissing
idsse/common
   __init__.py00100% 
   aws_utils.py270100% 
   boto3_utils.py813131 62%
   config.py6955 93%
   http_utils.py4044 90%
   json_message.py2411 96%
   log_util.py4133 93%
   path_builder.py2112222 90%
   protocol_utils.py9344 96%
   rabbitmq_rpc.py11022 98%
   rabbitmq_utils.py2263131 86%
   utils.py1892525 87%
   validate_schema.py400100% 
idsse/common/sci
   __init__.py00100% 
   bit_pack.py8533 96%
   geo_image.py2351717 93%
   grid_proj.py14277 95%
   netcdf_io.py693838 45%
   utils.py3177 77%
   vectaster.py1891717 91%
TOTAL190221789% 

Overview

The idss-engine-commons project is responsible for defining all implicit common dependencies that are used by the apps that make up the IDSS Engine Project distributed system. This repository should be used to house elements that are common across multiple projects to encourage reuse.

Twelve-Factors

The complete twelve-factors methodologies that the IDSS Engine Project adheres to can be found in the umbrella idss-engine repository. The subset of the twelve factors that follows are specifics to this app only.

Logging

To support some standardization and best practices for IDSS Engine, developers should following the logging guide found here

Contributing

Clone this repository.

Create a Python pip environment and activate it:

python3 -m venv .venv && source .venv/bin/activate

Install all Python dependencies based on what is installed in any of the GitHub Actions in .github/workflows, e.g. linter.yml.

pip install <libs_from_.github/workflows/linter.yml>

If you intend to run unit tests, you'll need to clone the idsse-testing GitHub repository, then install it as an "editable" (a.k.a. local) pip package:

pip install -e <path_to_idsse_testing_clone>/python

Formatting

Python code is formatted according to the black style guide, and any Pull Requests will be checked against this styling to ensure the new code has been auto-formatted.

To have black reformat all Python code every time you create a git commit, install the pre-commit library:

pip install pre-commit

And run this to have any Git pre-commit hooks installed for you according to .pre-commit.config.yaml:

pre-commit install

If you prefer, you can install the black library and run it yourself manually (not running on git commit):

pip install black

This will reformat all your Python files for you:

black . --line-length 99

Build, Release, and Run

The common images and packages within this project are built automatically by the project's GitHub Actions workflows using GitHub-hosted runners. No local or manual builds are necessary.

All common image build processes are managed through GitHub Actions and the associated configurations within the idss-engine-commons/docker directory.

Python Base Image (Basic)


Any Python-based microservice within IDSS Engine should use the following image as its base.

Image Name: ghcr.io/noaa-gsl/idss/commons/python/python-base:<semver>

Python Base Image (Scientific)


Any Python-based microservice within IDSS Engine that requires scientific Python packages (NumPy, NetCDF, etc.) should use this image as its base. This image also includes common Python utilities that other services can utilize. For specifics on these utilities, see the README within the idsse_commons directory.

Image Name: ghcr.io/noaa-gsl/idss/commons/python/python-sci:<semver>

Note: Both images are built and published through GitHub Actions. Developers do not need to run Docker Compose build commands or manually build these images locally.

Running IDSS Engine

See the Build, Release, Run section within the umbrella project documentation: [idss-engine](https://github.com/NOAA-GSL/idss-engine/blob/main/README.md#running-idss-engine)

About

Common implicit build dependencies for the IDSS Engine Project

Resources

Stars

0 stars

Watchers

3 watching

Forks

Releases

Packages

Used by

Contributors

Languages