diff --git a/.gitignore b/.gitignore index 556727d6..684107f3 100644 --- a/.gitignore +++ b/.gitignore @@ -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/ diff --git a/capstone_project/.python-version b/capstone_project/.python-version new file mode 100644 index 00000000..9919bf8c --- /dev/null +++ b/capstone_project/.python-version @@ -0,0 +1 @@ +3.10.13 diff --git a/capstone_project/README.md b/capstone_project/README.md index d34fb267..0c9e76fd 100644 --- a/capstone_project/README.md +++ b/capstone_project/README.md @@ -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. diff --git a/capstone_project/requirements.txt b/capstone_project/requirements.txt new file mode 100644 index 00000000..7cab68e9 --- /dev/null +++ b/capstone_project/requirements.txt @@ -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