This small library is used to validate configuration provided to Project Faros. It is designed to load a configuration file in YAML format from the Project Faros cluster-manager container's data directory and validate it against Pydantic models to ensure that the data is structured appropriately and valid. It returns the instantiated Pydantic object, which can be returned to a dictionary or JSON string depending on the nature of your operation with the configuration. It is used in Project Faros to validate and manipulate configuration files.
Faros Config is on PyPI. If you are connected to the internet, you can run pip install faros-config to install the configuration library and web application. You shouldn't, though, as it's designed to be installed when building cluster-manager containers.
To instantiate a development environment, you need at least python3 with the venv and pip modules, or virtualenv and pip or pip3 in your $PATH. From the project root:
pip install --upgrade --user pip setuptools wheel tox # This installs the development dependencies for your user.
# You should validate that the project works in your environment before you do anything to it.
tox # This lints, uses yarn to download JS dependencies, and runs the tests.
# A coverage report shows the current coverage status of the project. You should strive to raise it, or at least keep it the same.
python3 -m venv venv # This creates a virtual environment in a folder named "venv".
. venv/bin/activate # This activates the virtual environment.
pip install -e . # This installs the project to the venv in "editable" mode.
# To manually run the tests and see their output directly, you can run
pip install pytest python-dotenv
dotenv -f devel.env run python3 -m tests.test_config_examples
dotenv -f devel.env run python3 -m tests.test_inventoryThe GitHub workflow will automatically follow the release flow any time a tag is pushed. You can manually publish a release if you like, but you shouldn't.
It is important to run tox before any release. To generate a release, and push it to PyPi, ensure that you have a PyPi account, and Twine is configured, then run the following:
git clean -xdf # This completely sanitizes the directory to ensure a clean build. It's mostly optional, but a good idea.
git tag -s 0.1.0 # Or some other semver-compliant tag - this marks this version as the release version.
tox -e build && tox -e release # This will build source and binary distributions, publishing them to PyPI if the build succeeds.
# The versions of the packages are derived from the tag above.Note that, if you're not a maintainer of this project, you cannot release the package with the name faros-config because that is owned by the Project Faros maintainers. You should change the name if you need to publish it, or you can just use the build environment in tox without release and install from the files generated in the dist directory onto whatever host you're looking to get them to.
This project is licensed under the GNU GPL version 3. A copy of the license is included in this repository and all distributed packages.