Metadata-Version: 2.1
Name: code2docs-cli
Version: 0.1.0
Summary: 
Author: xKarinSan
Author-email: setsunayukii88@gmail.com
Requires-Python: >=3.12,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: python-dotenv (==1.1.0)
Requires-Dist: typer (==0.15.2)
Description-Content-Type: text/markdown

# Instructions

## Setup instructions
1. Clone this repo and go to this project
```
git clone https://github.com/xKarinSan/Code2Docs.git
cd Code2Docs
```

2. Go to code2docs_cli
```
cd code2docs-cli
```

3. Install all the dependencies
```
pip install -r requirements.txt
```

4. Run the app
```
cd code2docs_cli
python main.py
```

## Building instructions
1. Install poetry (More info on poetry <a href="https://python-poetry.org/docs/" target="_blank">poetry</a>). ```pipx``` is required (More info on pipx <a href="https://pipx.pypa.io/stable/installation/" target="_blank">here</a>)
```
pipx install poetry
```

2. Clone this repo and go to this project
```
git clone https://github.com/xKarinSan/Code2Docs.git
cd Code2Docs
```

3. Go to code2docs_cli
```
cd code2docs_cli
```

4. Install the project using poetry
```
poetry install
```

5. Open the poetry shell
```
poetry shell
```

6. Run the CLI 
```
code2docs-cli
```
