Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project Planner

Hey there! This is a little tool I put together to help with researching and planning projects. It's especially handy if you're into computer stuff and need ideas or detailed plans for your next big thing.

What it does

Basically, you give it a topic, and it goes through a few steps:

  1. It searches the web for current trends and overviews on that topic.
  2. Comes up with some fresh project ideas based on what it finds.
  3. Lets you pick which ideas sound good, then digs deeper into those.
  4. Saves everything into a nice markdown file for you to read later.

It's like having a research assistant that does the heavy lifting for you.

Features

  • Web Research: Pulls in real info from the internet using search tools.
  • Idea Generation: Spits out creative project suggestions.
  • Interactive Selection: You get to choose what interests you most.
  • Detailed Plans: Provides step-by-step guides, tech stacks, and timelines.
  • File Export: Everything gets saved as a readable markdown file.

Installation

You'll need Python 3.8 or higher. Clone this repo or download the files, then:

  1. Install the dependencies:

    pip install -r requirements.txt
    
  2. Set up your API keys. You'll need:

    • A Tavily API key (for web search)
    • A Google API key (for the AI model)

    Put them in a .env file like this:

    TAVILY_API_KEY=your_tavily_key_here
    GOOGLE_API_KEY=your_google_key_here
    

Usage

Run the script:

python script.py

It'll ask you for a research topic. Type something like "machine learning" or "web development", and it'll take it from there. Follow the prompts, and it'll generate a file with all the research.

Requirements

  • Python 3.8+
  • Internet connection (for web searches)
  • API keys as mentioned above

License

This is under the MIT License, so feel free to use it however you want. Check the LICENSE file for details.

If you have any questions or run into issues, just let me know!

About

plan/brainstorm ideas for projects

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages