Metadata-Version: 2.1
Name: breba-docs
Version: 0.1.2
Summary: Documentation assistant will proof read your docs
Home-page: https://github.com/breba-apps/breba-docs
License: MIT
Keywords: gpt,assistant,documentation
Author: Yason Khaburzaniya
Author-email: yason@hey.com
Requires-Python: >=3.12,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: docker (>=7.1.0,<8.0.0)
Requires-Dist: openai (>=1.38.0,<2.0.0)
Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
Requires-Dist: requests (>=2.32.3,<3.0.0)
Project-URL: Documentation, https://github.com/breba-apps/breba-docs
Project-URL: Repository, https://github.com/breba-apps/breba-docs
Description-Content-Type: text/markdown

# Breba Docs

_AI documentation validator_ 

## Features
Scans your documentation file and executes commands in the documentation
to make sure that it is possible to follow the documentation.

## Prerequisites
Install poetry and git

Get OpenAI API Key and set environment variable like this:
```bash
export OPENAI_API_KEY=[your_open_ai_api_key]
```

## Getting Started

To install breba-docs, run the following commands:

```bash
pip install breba-docs
breba_docs
```

Then you will need to provide location of a documentation file. 
For example: `breba_docs/sample_doc.md`

The software will then analyze the documentation and run the commands found in the documentation
inside a docker container with python installed.

The AI will then provide feedback regarding how it was able to follow the instructions.

