tmdl-parser 0.2.0

A Python library to parse and process TMDL (Table Metadata Description Language) files.

TMDLParser

A Python library designed to parse and process TMDL (Table Metadata Description Language) files

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Roadmap
5. Contributing
6. License
7. Contact
8. Acknowledgments

About The Project

TMDLParser is a Python library designed to parse and process TMDL (Table Metadata Description Language) files. It provides a structured way to handle data descriptions, properties, and calculations with an easy-to-use API.

• Parses TMDL files into structured Python objects.
• Handles multiple levels of nested properties.
• Supports detailed descriptions, elements, properties, and calculations.
• Easily integrates with other Python applications.
• Lightweight and easy to install.

(back to top)

Getting Started

Install the library directly from PyPI:

pip install tmdl-parser

Prerequisites

python>=3.10 Library uses only standart library and no 3th party.

Usage

Basic Example

from tmdlparser import TMLDParser

# Initialize the parser with a TMDL file path
parser = TMLDParser("path/to/tmdl/file.tmdl")

# Print the parsed structure
print(parser)

Results:

Description: Table Description
Element: Table Name
Properties:
    ----------
    Description: Column Description
    Element: Column Name
    Props: ['property_1', 'property_2']
    Calcs: ['calculation_1']
Calculation: ['Calculation Formula']
--------------------

Export formats

The parser can also return the parsed structure as a plain Python dictionary or as a pandas DataFrame for downstream analysis:

from tmdlparser import TMLDParser

parser = TMLDParser("path/to/project.pbip")
parser.parse_all_tables()

# Nested dict, ready for json.dumps() or any downstream processing.
data = parser.to_dict()

# Flat DataFrame (one row per TMDL entry, nested entries get parent_element set).
df = parser.to_dataframe()

# Or keep only the top-level entries with raw properties:
df_top = parser.to_dataframe(flatten=False)

to_dataframe() requires pandas, which is an optional dependency. Install it with:

pip install tmdl-parser[pandas]

Roadmap

• Publish to pip
• Create tests
• Better return format for parsed files

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Project Link: https://github.com/Atzingen/tmdl-parser

[e-mail]

(back to top)