https://github.com/aminekaabachi/lexy

📙 Lexy enables you to easily build and share data dictionaries to explain and document your data terminology using code.
https://github.com/aminekaabachi/lexy

data-catalog data-dictionaries data-dictionary documentation pandas pyspark

Last synced: about 2 months ago
JSON representation

📙 Lexy enables you to easily build and share data dictionaries to explain and document your data terminology using code.

• Host: GitHub
• URL: https://github.com/aminekaabachi/lexy
• Owner: aminekaabachi
• License: mit
• Created: 2022-01-11T21:53:33.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-01-17T01:23:26.000Z (over 4 years ago)
• Last Synced: 2025-03-27T03:34:37.298Z (about 1 year ago)
• Topics: data-catalog, data-dictionaries, data-dictionary, documentation, pandas, pyspark
• Language: Python
• Homepage:
• Size: 55.7 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Lexy

![test](https://github.com/aminekaabachi/lexy/workflows/test/badge.svg?branch=main) 

[![codecov](https://codecov.io/gh/aminekaabachi/lexy/branch/main/graph/badge.svg)](https://codecov.io/gh/aminekaabachi/lexy) 

[![PyPI](https://img.shields.io/pypi/v/lexy?style=flat-square)](https://pypi.org/project/lexy/)

[![Downloads](https://img.shields.io/pypi/dm/lexy?style=flat-square)](https://pypi.org/project/lexy/)

[![Docs](https://readthedocs.org/projects/lexy/badge/?version=latest&style=flat-square)](https://lexy.readthedocs.io/en/latest/)

[![GitHub](https://img.shields.io/github/license/aminekaabachi/lexy?style=flat-square)](https://github.com/aminekaabachi/lexy/blob/main/LICENSE)

[![Discord](https://img.shields.io/discord/932410374500786217?logo=discord)](https://discord.gg/RJurAU3HYh)

📙 ***Lexy** enables you to easily build and share data dictionaries to explain and document your data terminology using code.* The name "Lexy" is inspired from [lexicographer (/ˌlɛksɪˈkɒɡrəfə/)](https://www.lexico.com/definition/lexicographer), the person who compiles dictionaries.

-----------------

Easily document your data objects and generate beautiful data dictionaries:

```python

import lexy as xy

glossary = xy.Glossary()

#Defining glossary terms

glossary("name", "name of the student")

glossary("lastname", "lastname of the student")

glossary("age", "age of the student", sensitivity="private")

#Using the glossary to define pandas dataframe

import pandas as pd

data = [['tom', 'bird', 10], ['nick', 'star', 15], ['juli', 'aston', 14]] 

df = pd.DataFrame(data, columns = [glossary('name'), glossary('lastname'), glossary('age')]) 

xy.display_docs(glossary)

```

![Displayed docs](demo.png?raw=true "lexy Documentation")

## Beloved Features

**Lexy** will be soon ready for your use-case:

- ✔ Clear standard way to define data dictionaries using code.

- ✔ Tracking of glossary usage throughout the code.

- ✔ Display / Generate of documentation pages for your data glossaries.

- ✔ Detection of similarity between the terms and warning about possible data dictionary issues.

- Validation of data dictionaries using defined templates and rules.

- ✔ Import / export data dictionary from different formats (csv, excel, etc)

- AI Suggesting of metadata based on name and definition (personal data, data types, ...)

- Support for multiple backends (Memory, File, Redis, CloudFile...)

- Integration with Apache Atlas and Azure Purview.

- Publish data dictionary to lexyHub using the cli.