Metadata-Version: 2.1
Name: raggy
Version: 0.2.3
Summary: scraping stuff
License: MIT License
        
        Copyright (c) 2024 Nate Nowack
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE. 
Project-URL: Code, https://github.com/zzstoatzz/raggy
Keywords: scraping,nlp,ai,document-processing
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiofiles
Requires-Dist: bs4
Requires-Dist: chardet
Requires-Dist: fake-useragent
Requires-Dist: gh-util
Requires-Dist: openai>1.0.0
Requires-Dist: pypdf
Requires-Dist: tenacity
Requires-Dist: tiktoken
Requires-Dist: trafilatura
Requires-Dist: xxhash
Requires-Dist: yake
Provides-Extra: dev
Requires-Dist: ipython; extra == "dev"
Requires-Dist: mkdocs-autolinks-plugin~=0.7; extra == "dev"
Requires-Dist: mkdocs-awesome-pages-plugin~=2.8; extra == "dev"
Requires-Dist: mkdocs-markdownextradata-plugin~=0.2; extra == "dev"
Requires-Dist: mkdocs-material[imaging]>=9.1.17; extra == "dev"
Requires-Dist: mkdocstrings[python]~=0.22; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: pre-commit<4.0,>=2.21; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: types-aiofiles; extra == "dev"
Requires-Dist: raggy[tests]; extra == "dev"
Provides-Extra: tests
Requires-Dist: pytest-asyncio!=0.22.0,<0.23.0,>=0.18.2; extra == "tests"
Requires-Dist: pytest-env<2.0,>=0.8; extra == "tests"
Requires-Dist: pytest-rerunfailures<14,>=10; extra == "tests"
Requires-Dist: pytest-sugar<2.0,>=0.9; extra == "tests"
Requires-Dist: pytest~=7.3.1; extra == "tests"
Requires-Dist: pytest-timeout; extra == "tests"
Requires-Dist: pytest-xdist; extra == "tests"
Provides-Extra: chroma
Requires-Dist: chromadb; extra == "chroma"
Provides-Extra: tpuf
Requires-Dist: turbopuffer; extra == "tpuf"
Provides-Extra: pdf
Requires-Dist: pypdf; extra == "pdf"
Provides-Extra: scrapling
Requires-Dist: scrapling; extra == "scrapling"

# raggy

A Python library for scraping and document processing.

## Installation

```python
pip install raggy
```

For additional features:
```python
pip install raggy[scrapling]  # Enhanced web scraping via Scrapling
pip install raggy[chroma]     # ChromaDB support
pip install raggy[tpuf]       # TurboPuffer support
pip install raggy[pdf]        # PDF processing
```

Read the [docs](https://zzstoatzz.github.io/raggy/)

### What is it?

A Python library for:

- scraping the web to produce rich documents
- putting these documents in vectorstores
- querying the vectorstores to find documents similar to a query

> [!TIP]
> See this [example](https://github.com/zzstoatzz/raggy/blob/main/examples/chat_with_X/website.py) to chat with any website, or this [example](https://github.com/zzstoatzz/raggy/blob/main/examples/chat_with_X/repo.py) to chat with any GitHub repo.

### License and Dependencies

> [!IMPORTANT]
> This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
>
> When installing the optional `[scrapling]` dependency, please note that Scrapling is licensed under the BSD-3-Clause license. By using this optional feature, you agree to comply with [Scrapling's license terms](https://github.com/D4Vinci/Scrapling/blob/main/LICENSE).

### Contributing

We welcome contributions! See our [contributing guide](https://zzstoatzz.github.io/raggy/contributing) for details.
