gianluccacolangelo / AutoFlashcards

Give me your highlighted book before you go to bed, and you'll have fresh, finely processed flashcards by the morning
MIT License
3 stars 1 forks source link

Safely store api_key and fixed dependencies issues #3

Closed Aguscarpio closed 4 months ago

Aguscarpio commented 4 months ago

This pull request introduces several important enhancements to improve the project's setup and security:

  1. Added requirements.txt:

    • Created a requirements.txt file to list all the dependencies needed for the project. This ensures that anyone cloning the repository can easily install the necessary packages using pip install -r requirements.txt.
  2. Added .gitignore:

    • Introduced a .gitignore file to prevent sensitive files and unnecessary files from being tracked by Git. This includes ignoring environment-specific files and temporary files (e.g. cache).
  3. Implemented dotenv for Secure API Key Management:

    • Integrated python-dotenv to manage environment variables securely.
    • Updated the code to load environment variables from a .env file, ensuring that API keys and other sensitive information are not hard-coded in the source code.

Changes:

These changes will help in standardizing the project setup, enhancing security, and making the repository easier to manage and collaborate on.

gianluccacolangelo commented 4 months ago

Nice!