https://github.com/omarespejel/bojji

Automatic docs generator
https://github.com/omarespejel/bojji

Last synced: about 1 month ago
JSON representation

Automatic docs generator

• Host: GitHub
• URL: https://github.com/omarespejel/bojji
• Owner: omarespejel
• License: mit
• Created: 2023-03-24T02:33:11.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-24T02:51:33.000Z (almost 2 years ago)
• Last Synced: 2024-03-27T22:37:20.143Z (10 months ago)
• Language: Python
• Size: 2.93 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Bojji

This script generates documentation for Cairo files in a GitHub repository using GPT-4 and outputs it in AsciiDoc format.

## Installation

1. Clone the repository.

2. Change into the repository directory: `cd bojji`.

3. Install the dependencies: `pip install -r requirements.txt`. You may want to use a virtual environment. See [this guide](https://docs.python.org/3/tutorial/venv.html) for more information.

## Usage

Before running the script, make sure to set the following environment variables:

- `OPENAI_API_KEY`: Your OpenAI API key

- `GITHUB_TOKEN`: Your GitHub personal access token

- `GITHUB_OWNER`: The GitHub username of the repository owner

- `GITHUB_REPO`: The name of the GitHub repository

Run the script using the following command:

```python

python src/generate_documentation.py

```