Metadata-Version: 2.4
Name: cs2fade
Version: 0.3.1
Summary: CS2 fade utility
License: GPL-3.0-or-later
License-File: LICENSE
Author: Lukas Mahler
Author-email: m@hler.eu
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Project-URL: Repository, https://github.com/Helyux/cs2fade
Description-Content-Type: text/markdown

<div id="shields" align="center">

<!-- PROJECT SHIELDS -->
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![Downloads][downloads-shield]][downloads-url]
[![GPLv3 License][license-shield]][license-url]
</div>

# cs2fade

Python port of [@chescos](https://github.com/chescos) original
[csgo-fade-percentage-calculator](https://github.com/chescos/csgo-fade-percentage-calculator).  
Check out his repository for more information.  
For a usage example, refer to [`example.py`](./example.py).

## Quick start

```python
import cs2fade

info = cs2fade.get("M4A1-S", 374)
print(f"#{info.ranking} / {info.percentage} / {info.finish}")
# => "#1 / 100.0 / fade"

info = cs2fade.get("M4A1-S", 739)
print(f"#{info.ranking} / {info.percentage} / {info.finish}")
# => "#1 / 80.0 / fade"
```

The helper infers the correct finish for the given weapon. If you need low-level
access to the calculators, the original classes remain available:

```python
from cs2fade import AcidFade

fade = AcidFade.get_percentage("SSG 08", 374)
```

If you notice any errors, please feel free to open an issue or pull request.

<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/Helyux/cs2fade.svg?style=for-the-badge
[contributors-url]: https://github.com/Helyux/cs2fade/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Helyux/cs2fade.svg?style=for-the-badge
[forks-url]: https://github.com/Helyux/cs2fade/network/members
[stars-shield]: https://img.shields.io/github/stars/Helyux/cs2fade.svg?style=for-the-badge
[stars-url]: https://github.com/Helyux/cs2fade/stargazers
[issues-shield]: https://img.shields.io/github/issues/Helyux/cs2fade.svg?style=for-the-badge
[issues-url]: https://github.com/Helyux/cs2fade/issues
[downloads-shield]: https://img.shields.io/pepy/dt/cs2fade?style=for-the-badge
[downloads-url]: https://pepy.tech/project/cs2fade
[license-shield]: https://img.shields.io/badge/License-GPLv3-red.svg?style=for-the-badge
[license-url]: https://github.com/Helyux/cs2fade/blob/master/LICENSE

