Metadata-Version: 2.1
Name: llama-index-readers-stackoverflow
Version: 0.1.3
Summary: llama-index readers stackoverflow integration
License: MIT
Keywords: answers,posts,questions
Author: Your Name
Author-email: you@example.com
Maintainer: allen-munsch
Requires-Python: >=3.8.1,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: llama-index-core (>=0.10.1,<0.11.0)
Requires-Dist: requests (>=2.31.0,<3.0.0)
Description-Content-Type: text/markdown

# StackoverflowReader (In Beta)

Using the Stackoverflow API, this class will read the Stackoverflow Teams API and return a list of questions and answers based on posts.

It also supports caching the results to a local directory, so that you can run the load_data() method multiple times without hitting the API.

## getting a token

Visit: https://stackoverflowteams.com/users/pats/

1. Click Create a new PAT
2. Name the token, and pick the team scope
3. Select an expiration date
4. Click Create

Add this to your env, or to the instantiation of the `StackoverflowReader(pa_token, team_name, cache_dir='./stackoverflow_cache')`

```bash
export STACKOVERFLOW_PAT=your_token
export STACKOVERFLOW_TEAM_NAME=your_team
```

Other features which could be added:

- Add articles
- Add comments
- Add tags
- Add users
- Add votes
- Add badges

