Metadata-Version: 2.4
Name: csfloat_client
Version: 0.1.1
Summary: An unofficial, asynchronous Python API wrapper for the CSFloat marketplace.
Project-URL: Homepage, https://github.com/edlzitrone/csfloat-client
Project-URL: Repository, https://github.com/edlzitrone/csfloat-client
Project-URL: Documentation, https://edlzitrone.github.io/csfloat-client/
Project-URL: Issues, https://github.com/edlzitrone/csfloat-client/issues
Author: EdlZitrone
License-Expression: MIT
License-File: LICENSE
Keywords: api-wrapper,cs2,csfloat,csgo,steam
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: AsyncIO
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
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
Classifier: Typing :: Typed
Requires-Python: >=3.9
Requires-Dist: aiohttp>=3.8.0
Requires-Dist: pydantic>=2.0.0
Provides-Extra: dev
Requires-Dist: mypy>=1.0; extra == 'dev'
Requires-Dist: pdoc>=14.0; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
Requires-Dist: pytest>=7.0; extra == 'dev'
Requires-Dist: python-dotenv>=1.0; extra == 'dev'
Requires-Dist: ruff>=0.1; extra == 'dev'
Description-Content-Type: text/markdown

# csfloat_client

An **unofficial, lightweight** Python API wrapper for the [CSFloat](https://csfloat.com) marketplace.

---

[![PyPI version](https://img.shields.io/pypi/v/csfloat-client.svg?style=for-the-badge&logo=pypi&color=blue&logoColor=white)](https://pypi.org/project/csfloat-client/)
[![Python versions](https://img.shields.io/pypi/pyversions/csfloat-client.svg?style=for-the-badge&logo=python&logoColor=white)](https://pypi.org/project/csfloat-client/)
[![Documentation](https://img.shields.io/badge/docs-github%20pages-blue?style=for-the-badge&logo=readthedocs&logoColor=white)](https://edlzitrone.github.io/csfloat-client/)

---

csfloat_client provides a modern, easy-to-use interface built on `async`/`await`  
to interact with all CSFloat marketplace features directly from Python. It is  
kept up-to-date with the CSFloat API and includes thorough documentation for  
every function.

This library is centered around a single `Client` class, which is initialized  
with an API key and grants access to **all** CSFloat activities and information,  
including listings, offers, buy orders and more.

## Installation

```bash
pip install csfloat_client
```

## Quick Start

```python
import asyncio
from csfloat_client import Client

async def main():
    async with Client(api_key="YOUR_API_KEY") as client:
        listings = await client.get_listings(sort_by='best_deal', min_ref_qty=20)
        print(f"{listings[0].item.item_name} - {listings[0].price}")

asyncio.run(main())
```

## Features

- Fully asynchronous (built on `aiohttp`)  
- Validated response models via `pydantic`  
- Typed (`py.typed`) for full IDE/mypy support  
- Thorough documentation generated with `pdoc`  

## Documentation

Full documentation: https://edlzitrone.github.io/csfloat-client/

## License

This project is licensed under the [MIT License](LICENSE).