breba-docs

Name	breba-docs JSON
Version	0.1.5 JSON
	download
home_page	https://github.com/breba-apps/breba-docs
Summary	Documentation assistant will proof read your docs
upload_time	2024-08-29 15:26:46
maintainer	None
docs_url	None
author	Yason Khaburzaniya
requires_python	<4.0,>=3.10
license	MIT
keywords	gpt assistant documentation
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Breba Docs

_AI documentation validator_ 

![workflow](https://github.com/breba-apps/breba-docs/actions/workflows/test.yaml/badge.svg?branch=main)

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

## Prerequisites
Docker engine needs to be installed and running. Use docker installation instructions for your system.

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.


            

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/9e/88/6875880e339aa1313a9e743144e3fda6bd2d1d86fed342f404b349768951/breba_docs-0.1.5.tar.gz",
    "platform": null,
    "description": "# Breba Docs\n\n_AI documentation validator_ \n\n![workflow](https://github.com/breba-apps/breba-docs/actions/workflows/test.yaml/badge.svg?branch=main)\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## Prerequisites\nDocker engine needs to be installed and running. Use docker installation instructions for your system.\n\nGet OpenAI API Key and set environment variable like this:\n```bash\nexport OPENAI_API_KEY=[your_open_ai_api_key]\n```\n\n## Getting Started\n\nTo install 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",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Documentation assistant will proof read your docs",
    "version": "0.1.5",
    "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": "0070bd8244956837eb05d73a76260085bd9cbf907fa1ee703f62324d4d8eaaca",
                "md5": "db68672e2be3405d8081024e09061e17",
                "sha256": "addcce30667494a6cddf4c6217154fa2a99345f4bf956bf52e60317e0bbe5ec2"
            },
            "downloads": -1,
            "filename": "breba_docs-0.1.5-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "db68672e2be3405d8081024e09061e17",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.10",
            "size": 7615,
            "upload_time": "2024-08-29T15:26:45",
            "upload_time_iso_8601": "2024-08-29T15:26:45.230077Z",
            "url": "https://files.pythonhosted.org/packages/00/70/bd8244956837eb05d73a76260085bd9cbf907fa1ee703f62324d4d8eaaca/breba_docs-0.1.5-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9e886875880e339aa1313a9e743144e3fda6bd2d1d86fed342f404b349768951",
                "md5": "86ef438884064b3513aaae020421197d",
                "sha256": "6d1fc0877530c7b9cf8fa8c808ea4e2d7f3dafd6c27e699b2d24c3af51286d97"
            },
            "downloads": -1,
            "filename": "breba_docs-0.1.5.tar.gz",
            "has_sig": false,
            "md5_digest": "86ef438884064b3513aaae020421197d",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.10",
            "size": 5649,
            "upload_time": "2024-08-29T15:26:46",
            "upload_time_iso_8601": "2024-08-29T15:26:46.498251Z",
            "url": "https://files.pythonhosted.org/packages/9e/88/6875880e339aa1313a9e743144e3fda6bd2d1d86fed342f404b349768951/breba_docs-0.1.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-29 15:26:46",
    "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"
}