diff --git a/.github/assets/pypi_desc.md b/.github/assets/pypi_desc.md new file mode 100644 index 0000000..ad29898 --- /dev/null +++ b/.github/assets/pypi_desc.md @@ -0,0 +1,12 @@ +# Phaistos + +The main goal of this project is to provide flexibility and utility in defining data models using YAML manifests, +to enforce data validation of objects such as ETL pipeline payloads, API requests and responses, configurations and more. + +These definitions are to be kept as easily versionable and maintainable files, which can be easily read and understood by +both developers and non-developers alike. + +The main features of Phaistos are: + +* Define data models using YAML manifests for easy readability, versioning and maintainability +* Add custom validators to data fields that are automatically injected into Pydantic models diff --git a/setup.py b/setup.py index fb3afbc..01399f9 100644 --- a/setup.py +++ b/setup.py @@ -1,7 +1,7 @@ import os import setuptools # type: ignore -with open("README.md", "r", encoding="utf-8") as fh: +with open(".github/assets/pypi_desc.md", "r", encoding="utf-8") as fh: long_description = fh.read() if version := os.environ.get("RELEASE_VERSION"):