# Breba Docs
_AI documentation validator_
[](https://github.com/breba-apps/breba-docs/actions/workflows/test.yaml?query=branch%3Amain)
## Features
Scans your documentation file and executes commands in the documentation
to make sure that it is possible to follow the documentation.
## Getting Started
### Prerequisites
Docker engine needs to be installed and running. Use docker installation instructions for your system.
Get an OpenAI API Key and set environment variable like this:
```bash
export OPENAI_API_KEY=[your_open_ai_api_key]
```
### Install and Run
To install and run 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.
## Contributing
For contributing to the project, please refer to [Contribution Guide](docs/CONTRIBUTING.md).
Raw data
{
"_id": null,
"home_page": "https://github.com/breba-apps/breba-docs",
"name": "breba-docs",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "gpt, assistant, documentation",
"author": "Yason Khaburzaniya",
"author_email": "yason@hey.com",
"download_url": "https://files.pythonhosted.org/packages/03/d0/35b5d005b7d32d808f4d62d4f00d6bae6a7a29499c307a06c3151a2a0676/breba_docs-0.1.7.tar.gz",
"platform": null,
"description": "# Breba Docs\n\n_AI documentation validator_ \n\n[](https://github.com/breba-apps/breba-docs/actions/workflows/test.yaml?query=branch%3Amain)\n\n## Features\nScans your documentation file and executes commands in the documentation\nto make sure that it is possible to follow the documentation.\n\n## Getting Started\n\n### Prerequisites\nDocker engine needs to be installed and running. Use docker installation instructions for your system.\n\nGet an OpenAI API Key and set environment variable like this:\n```bash\nexport OPENAI_API_KEY=[your_open_ai_api_key]\n```\n\n### Install and Run\nTo install and run breba-docs, run the following commands:\n\n```bash\npip install breba-docs\nbreba_docs\n```\n\nThen you will need to provide location of a documentation file. \nFor example: `breba_docs/sample_doc.md`\n\nThe software will then analyze the documentation and run the commands found in the documentation\ninside a docker container with python installed.\n\nThe AI will then provide feedback regarding how it was able to follow the instructions.\n\n## Contributing\nFor contributing to the project, please refer to [Contribution Guide](docs/CONTRIBUTING.md). \n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Documentation assistant will proof read your docs",
"version": "0.1.7",
"project_urls": {
"Documentation": "https://github.com/breba-apps/breba-docs",
"Homepage": "https://github.com/breba-apps/breba-docs",
"Repository": "https://github.com/breba-apps/breba-docs"
},
"split_keywords": [
"gpt",
" assistant",
" documentation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e8b0d362c5e6ffbad37d0db723424bc9066ce2c7b13fffce581afe70052fd639",
"md5": "878a742c45d94011aaa8b6e2c6940ddc",
"sha256": "11976fb93b918dfd7f3dd16d176050272b28e56584566209411b250253e17b86"
},
"downloads": -1,
"filename": "breba_docs-0.1.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "878a742c45d94011aaa8b6e2c6940ddc",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 14475,
"upload_time": "2024-10-23T22:42:17",
"upload_time_iso_8601": "2024-10-23T22:42:17.327919Z",
"url": "https://files.pythonhosted.org/packages/e8/b0/d362c5e6ffbad37d0db723424bc9066ce2c7b13fffce581afe70052fd639/breba_docs-0.1.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "03d035b5d005b7d32d808f4d62d4f00d6bae6a7a29499c307a06c3151a2a0676",
"md5": "e4e47d17477f870f448addd6d902539a",
"sha256": "874f049778c666da7c14d082902f2db8afc2fda4a4f91ff52d393ae69cf2c27b"
},
"downloads": -1,
"filename": "breba_docs-0.1.7.tar.gz",
"has_sig": false,
"md5_digest": "e4e47d17477f870f448addd6d902539a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 10972,
"upload_time": "2024-10-23T22:42:18",
"upload_time_iso_8601": "2024-10-23T22:42:18.952131Z",
"url": "https://files.pythonhosted.org/packages/03/d0/35b5d005b7d32d808f4d62d4f00d6bae6a7a29499c307a06c3151a2a0676/breba_docs-0.1.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-23 22:42:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "breba-apps",
"github_project": "breba-docs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "breba-docs"
}
JSON
