Skip to content

Commit

Permalink
Update project dependency files.
Browse files Browse the repository at this point in the history
  • Loading branch information
eli64s committed Jan 5, 2024
1 parent 7f97592 commit f7b8224
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 27 deletions.
36 changes: 12 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -281,9 +281,9 @@ See the <a href="#-configuration">Configuration</a> section below for the comple
</tr>
<tr>
<td>3️⃣</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/markdown/readme-javascript.md">readme-javascript.md</a></td>
<td><a href="https://github.com/idosal/assistant-chat-gpt-javascript">(repository deleted)</a></td>
<td>JavaScript, React</td>
<td><a href="https://github.com/eli64s/readme-ai/blob/main/examples/markdown/readme-postgres.md">readme-postgres.md</a></td>
<td><a href="https://github.com/jwills/buenavista">postgres-proxy-server</a></td>
<td>Python, Postgres, Duckdb, Docker</td>
</tr>
<tr>
<td>4️⃣</td>
Expand Down Expand Up @@ -351,19 +351,7 @@ A repository URL or local path to your codebase is required run readme-ai. The f

**OpenAI API Key**

An OpenAI API account and API key are needed to use *readme-ai*. The following steps outline the process.

<details closed>
<summary>🔐 OpenAI API Account Setup</summary>
<ol>
<li>Go to the <a href="https://platform.openai.com/">OpenAI website</a>.</li>
<li>Click the "Sign up for free" button.</li>
<li>Fill out the registration form with your information and agree to the terms of service.</li>
<li>Once logged in, click on the "API" tab.</li>
<li>Follow the instructions to create a new API key.</li>
<li>Copy the API key and keep it in a secure place.</li>
</ol>
</details>
An OpenAI API account and API key are needed to use *readme-ai*. Get started by creating an account [here](https://platform.openai.com/docs/quickstart/account-setup). Once you have an account, you can create an API key on the [API settings page](https://platform.openai.com/api-keys).

> [!WARNING]
>
Expand Down Expand Up @@ -395,11 +383,16 @@ conda install -c conda-forge readmeai
Alternatively, clone the readme-ai repository and build from source.

```sh
git clone https://github.com/eli64s/readme-ai && \
git clone https://github.com/eli64s/readme-ai
```

Change into the project directory.

```sh
cd readme-ai
```

Then use one of the methods below to install the project's dependencies (Bash, Conda, Pipenv, or Poetry).
And install the dependencies using one of the methods below.

Using `bash`
```sh
Expand All @@ -420,7 +413,7 @@ poetry shell

---

### 👩‍💻 Running *README-AI*
### 👩‍💻 Running *readme-ai*

Before running the application, ensure you have an OpenAI API key and its set as an environment variable.

Expand Down Expand Up @@ -554,11 +547,6 @@ The readme-ai tool is designed with flexibility in mind, allowing users to confi
<details closed><summary>🔠 Configuration Models</summary>
<br>

<!--
# README-AI Configuration and Settings
This documentation provides an overview of the configuration and settings for the README.ai CLI tool. It details various data models and functions that are used to configure the tool, making it adaptable for different environments and use cases.
-->

***GitService Enum***

- **Purpose**: Defines Git service details.
Expand Down
20 changes: 18 additions & 2 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"

[tool.poetry]
name = "readmeai"
version = "0.4.0988"
version = "0.4.0989"
description = "🚀 Generate beautiful README.md files from the terminal using GPT LLM APIs 💫"
authors = ["Eli <[email protected]>"]
license = "MIT"
Expand Down Expand Up @@ -54,6 +54,7 @@ tenacity = "^8.2.2"
tiktoken = "^0.4.0"
toml = "^0.10.2"
pydantic = ">=1.10.9,<2.0.0"
setuptools = "^69.0.3"

[tool.poetry.dev-dependencies]
pytest = "*"
Expand Down

0 comments on commit f7b8224

Please sign in to comment.