Metadata-Version: 2.3
Name: freeds
Version: 0.2.18
Summary: The free data stack CLI
License: GNU GENERAL PUBLIC LICENSE v3
Author: Jens Köster
Author-email: freeds@jensbox.se
Requires-Python: >=3.11,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: apache-airflow-client (>=2.10.0,<3.0.0)
Requires-Dist: boto3 (>=1.38.19,<2.0.0)
Requires-Dist: docker (>=7.1.0,<8.0.0)
Requires-Dist: gitpython (>=3.1.44,<4.0.0)
Requires-Dist: nbformat (>=5.10.4,<6.0.0)
Requires-Dist: nbstripout (>=0.8.1,<0.9.0)
Requires-Dist: papermill (>=2.6.0,<3.0.0)
Requires-Dist: requests (>=2.32.3,<3.0.0)
Requires-Dist: ruamel-yaml (>=0.18.12,<0.19.0)
Requires-Dist: typer[all] (>=0.10.0)
Description-Content-Type: text/markdown

# freeds
The free data stack CLI and lib.
The project is managed in `poetry` and uses CLI framework `typer`.

## The freeds CLI
* Setup freeds for first use, create directories, clone repos, collect secrets etc
* Run docker compose commands on the stack in the relevant order, providing the appropriate environment.
* Deploy and manage notebook files on s3.
* Stack and lab operations like inspecting the available labs/stacks and activating a lab/stack.
* Testing freeds stack health by running a set of real but minimal operations.

## The freeds Package
* Unified access to config, as file or via config server.
* Unified view of the plugins.
* Unified view of repos, providing the union of the-free-data-stack and the configured lab. Regarding dags, configs, notebooks etc
* Simplified S3 management, put, get, list files and prefixes, using the freeds config.
* Simplified Spark management, setting up a connection using the freeds config and S3 connectivity.

