Metadata-Version: 2.4
Name: pbi-git
Version: 0.5.1
Summary: Creation of git diff reports for Power BI files
Project-URL: Homepage, https://github.com/douglassimonsen/pbi_git
Project-URL: Documentation, https://douglassimonsen.github.io/pbi_git/
License-File: LICENSE
Requires-Python: >=3.11.0
Requires-Dist: pbi-core>=0.3.7
Requires-Dist: svgwrite>=1.4.3
Provides-Extra: dev
Requires-Dist: ruff; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs-material>=9.6.16; extra == 'docs'
Requires-Dist: mkdocs>=1.6.1; extra == 'docs'
Requires-Dist: mkdocstrings-python>=0.30.0; extra == 'docs'
Provides-Extra: pdf
Requires-Dist: linkify-it-py>=2.0.3; extra == 'pdf'
Requires-Dist: markdown-pdf>=1.7; extra == 'pdf'
Description-Content-Type: text/markdown

# Overview


[![PyPI Downloads](https://static.pepy.tech/badge/pbi-git)](https://pepy.tech/projects/pbi-git)
![Python](https://img.shields.io/badge/python-3.11-blue.svg)
[![Coverage Status](https://coveralls.io/repos/github/douglassimonsen/pbi_git/badge.svg?branch=main)](https://coveralls.io/github/douglassimonsen/pbi_git?branch=main)
![Repo Size](https://img.shields.io/github/repo-size/douglassimonsen/pbi_git)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fdouglassimonsen%2Fpbi_git.svg?type=shield&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fdouglassimonsen%2Fpbi_git?ref=badge_shield&issueType=license)
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fdouglassimonsen%2Fpbi_git.svg?type=shield&issueType=security)](https://app.fossa.com/projects/git%2Bgithub.com%2Fdouglassimonsen%2Fpbi_git?ref=badge_shield&issueType=security)

Read the [documentation](https://douglassimonsen.github.io/pbi_git/) for more information.


`pbi_git` is a package for generating markdown documentation for changes Power BI files, making report evolution easier to track.

# Dev Instructions


## Virtual Environment

```shell
python -m venv venv
venv\Scripts\activate
python -m pip install .[dev]
# pre-commit install
```

## Building package

```shell
python -m build .
```

## Running the Documentation Server

```shell
python -m pip install .[docs]
mkdocs serve -f docs/mkdocs.yml
```

## Deploy docs to Github Pages

```shell
mkdocs  gh-deploy --clean -f docs/mkdocs.yml
```