fideslib

Installation

pip install fideslib

Usage

Config

Examples here will assume a project structure of src/my_project where my_project is the root module.

To use the default config settings create a module and file to store the config. In this example we will use src/my_project/core/config.py.

from fideslib.core.config import get_config

config = get_config()

Then the config can be used in other files by importing config.

from my_project.core.config import config

The default config can be overridden by extending the settings classes. With the same setup as above, in the src/my_project/core/config.py file:

from fideslib.core.config import DatabaseSettings, FidesSettings, get_config


class ExtendedDataBaseSettings(DatabaseSettings):
    extra_field: str

    class Config:
        env_prefix = "FIDESOPS__DATABASE__"


class ExtendedFidesSettings(FidesSettings):
    database: ExtendedDataBaseSettings


config = get_config(ExtendedDataBaseSettings)  # pass the name of the custom settings class here

Now the resulting config.database will contain the extra extra_field field and ExtendedDataBaseSettings will look for environment variables with FIDESOBS__DATABASE__.

Contributing

We welcome and encourage all types of contributions and improvements!

Read about the Fides community or dive into the development guides for information about contributions, documentation, code style, testing, and more. Ethyca is committed to fostering a safe and collaborative environment, such that all interactions are governed by the Fides Code of Conduct.

License

The Fides ecosystem of tools are licensed under the Apache Software License Version 2.0. Fides tools are built on Fideslang, the Fides language specification, which is licensed under CC by 4.