Skip to content

IDinsight/IdeaGenerator

Repository files navigation

Idea Generator

Generate ideas!

Docstring coverage: interrogate   Linting: pylint

Setup Instructions

  1. Copy backend/.template.env to backend/.env.
  2. Copy the root .template.env to .env and update:
    1. OPENAI_API_KEY: Your OpenAI API key.
    2. PATHS_LOGS_DIR: The absolute path to the logs directory for the project.
    3. PATHS_PROJECT_DIR: The absolute path to the root directory of the project.

Startup Instructions

  1. Install direnv.
  2. Install the latest version of uv using: curl -LsSf https://astral.sh/uv/install.sh | sh
  3. Clone the repo (git clone git@github.com:IDinsight/IdeaGenerator.git) and cd into the root directory of the repo.
  4. Allow direnv to load the environment variables by running direnv allow.
  5. cd backend
    1. Allow direnv to load the environment variables by running direnv allow. This should allow direnv to load all environment variables for the backend.
    2. Execute make fresh-env. This will create a new virtual environment for the backend and install all dependencies.
    3. Execute source .venv/bin/activate: This will activate the virtual environment created by make fresh-env.
  6. Execute python src/idea_generator/entries/single_island.py: This will run the single island mutation demo and will cost approximately $0.40 if you are using gpt-4o.
  7. Execute python src/idea_generator/entries/multi_island.py: This will run the multi-island mutation demo and will cost approximately $0.80 if you are using gpt-4o.

Clean up Instructions

  1. In the backend directory, execute deactivate. This will exit out of the virtual environment created by uv.

About

Generate ideas!

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published