Transcribing schemas from YAML-infused tablets to magical Pydantic validation models 🧙♂️🧙♀️
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 💉
For installation and usage instructions, please refer to the documentation.
The Phaistos name comes from the Phaistos Disc, a disk of fired clay from the Minoan palace of Phaistos on the island of Crete, possibly dating to the middle or late Minoan Bronze Age (2nd millennium BC). These discs contain a series of symbols that are still undeciphered to this day.
In the show of unprecedented far-reaching, the resulting data models from Phaistos can be viewed as such "discs" containing malleable and abstract data validation dialects that can exist in a variety of forms and can be used to validate a variety of data payloads. Also - we used to burn data into disks 💽, so there's another angle to the name. 🤷♂️
The examples folder contains scripts and schemas that demonstrate how to use Phaistos to define and validate data models. The examples are written in Python and are intended to be run from the command line.
More information about the examples can be found in the examples README.
Want more? You can check out tests in the tests directory for more examples of how to use Phaistos, however, expect some Python-fu and a lot of test-related code
e.g. monkey-patching, fixtures, etc. Viewer discretion is advised.
Thank you for considering contributing to this project! We welcome contributions from everyone. By participating, you agree to abide by the following guidelines:
-
Fork the Repository: Start by forking the repository on GitHub.
-
Clone Your Fork: Clone your fork to your local machine.
git clone https://github.com/your-username/your-fork.git
-
Create a Branch: Create a feature branch for your work.
git checkout -b feature-branch
-
Make Your Changes: Make your changes and commit them with clear and descriptive commit messages.
git commit -m "Description of your changes" -
Push to Your Fork: Push your changes to your forked repository.
git push origin feature-branch
-
Submit a Pull Request: Open a pull request on the original repository with a description of your changes. Please ensure your PR includes any relevant tests and follows the project’s coding conventions and guidelines.
If you encounter any issues or bugs, please open an issue on GitHub. Be sure to include detailed information about the problem and how to reproduce it.
This project is licensed under the GNU General Public License Version 3 (GPLv3). See the LICENSE file for the full text.