Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat/ghaar/capstone init #1

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
.idea
*.log
tmp/
venv/

# Ignore keys (replace 'your_keys_directory' and 'your_keys_filename' with the actual names)
# your_keys_directory/
Expand Down
1 change: 1 addition & 0 deletions capstone_project/.python-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
3.10.13
5 changes: 4 additions & 1 deletion capstone_project/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,10 @@ Before plunging into the project:
- Equip yourself with a basic understanding of Python (or another ChatGPT API-supported language).
- Set up your development environment (e.g., Python environment, code editor).
- Procure an OpenAI API key from [OpenAI’s platform](https://www.openai.com/).
- IMPORTANT: Place your API key within a `.env` file as `API_KEY=your_actual_key_here`. This ensures your credentials remain private and are not unintentionally shared.
- IMPORTANT: Place your API key within a `.env` file as `OPENAI_API_KEY=your_actual_key_here`. This ensures your credentials remain private and are not unintentionally shared.
- Make sure the \`capstone_project\` directory is your current working directory.
- Make sure you have the correct version of Python installed (defined in the `.python-version` file).
- Run \`pip install -r requirements.txt\` to install the required dependencies.


<a id="org9c4e782"></a>
Expand Down
16 changes: 16 additions & 0 deletions capstone_project/requirements.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
annotated-types==0.6.0
anyio==3.7.1
certifi==2023.11.17
distro==1.8.0
exceptiongroup==1.2.0
h11==0.14.0
httpcore==1.0.2
httpx==0.25.2
idna==3.6
openai==1.3.5
pydantic==2.5.2
pydantic_core==2.14.5
python-dotenv==1.0.0
sniffio==1.3.0
tqdm==4.66.1
typing_extensions==4.8.0