Metadata-Version: 2.4
Name: stackgpt
Version: 0.1.0
Summary: StackOverflow-style GPT assistant for your terminal
Author-email: Ayub Farxaan <a.farxaan@programmer.net>
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: openai
Requires-Dist: click
Requires-Dist: python-dotenv
Requires-Dist: rich
Dynamic: license-file

# Welcome to StackGPT

Hey there! 👋 Welcome to the StackGPT GitHub repository. This project is a terminal-based assistant that answers your programming questions just like StackOverflow — fast, concise, and powered by AI.

## About StackGPT

StackGPT is designed to help developers debug and understand errors quickly by generating StackOverflow-style answers from your error messages or code snippets.
- Fast CLI interface  
- Markdown output in terminal  
- Powered by OpenAI GPT-4  
- Simple to install and use

## Getting Started

Ready to boost your debugging? Follow these steps:

1. **Clone the repository**:  
   ```bash
   git clone https://github.com/buuya/stackgpt.git
   cd stackgpt
2. **Install dependencies**:

   ```bash
   pip install -r requirements.txt
3. **Setup your OpenAI API key**:

   * Copy `.env.example` to `.env`
   * Add your OpenAI key to `.env`

   ```
   OPENAI_API_KEY=sk-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
4. **Run the CLI**:

   ```bash
   stackgpt "Your error or question here"

   or

   ```bash
   stackgpt --file error_log.txt

## Contribution Guidelines

We ❤️ contributions! If you'd like to improve StackGPT or add features, here’s how:

* Fork the repository
* Create a new branch: `git checkout -b feature/your-feature`
* Make your changes and commit: `git commit -m 'Add feature'`
* Push to your branch: `git push origin feature/your-feature`
* Open a pull request

Let's build a smarter debugging tool together!

## Code of Conduct

Please review and adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) to help us maintain a welcoming community.

## License

StackGPT is licensed under the MIT License. See [LICENSE](LICENSE) for details.

---

## 👨‍💻 Built By

**Ayub Farxaan** under **Buuya Studious Lab**
GitHub: [@buuya](https://github.com/buuya)
Twitter: [@cptbuuya](https://github.com/cptbuuya)


