Skip to content

Commit

Permalink
Update setup.py to read long description from .github/assets/pypi_des…
Browse files Browse the repository at this point in the history
…c.md
  • Loading branch information
Kamil Rybacki committed Jul 3, 2024
1 parent c99eb51 commit 9665266
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 1 deletion.
12 changes: 12 additions & 0 deletions .github/assets/pypi_desc.md
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
@@ -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"):
Expand Down

0 comments on commit 9665266

Please sign in to comment.