Welcome to Aviv Data Contract Documentation Website

This repository contains data contract declarations used by the Data Platform v2.

Every contract should be composed of data schema, business & technical annotations in order to define the exchange of information between data producers and data consumers.

Pre-requisites

• You must have uv already installed

Never heard of this utility?

uv is a cutting-edge Python package and project manager built with Rust combining the functionality of tools like pip, poetry, and virtualenv, uv streamlines tasks like dependency management, script execution, and project building—all with exceptional performance. Its seamless compatibility with pip commands, requiring no additional learning curve. Find install instructions [here](https://avivgroup.atlassian.net/wiki/x/jABEew)

• You must have gh configured to access the organization's repositories and to create new contracts interactively

Can you help me to authenticate ?

To check if everything works: >

gh auth status

If you need to configure, run the following and accept the terms: >

gh auth login --git-protocol https --hostname github.com --web

Installation

Clone the project repository:

gh repo clone https://github.com/axel-springer-kugawana/aviv_data_collection_contracts

Initialize the project and related dependencies:

uv --directory aviv_data_collection_contracts run task init

Getting started

For the next steps, please consult the user documentation and read this guide to understand Data Contract syntax

Documentation

[!IMPORTANT] Use Aviv VPN to access the documentation links

A static website is generated and pushed for each live release (i.e. at each git tag): Official documentation website

[!NOTE] You have the possibility to see the working state in the Development website

Examples

We are gonna to add regularly contract examples in this folder.

FAQ

If you have any problems or errors, please consult the FAQ or post a message in #aviv_data_support.