Metadata-Version: 2.4
Name: pyproxytools-sdk
Version: 0.1.2
Summary: Python API Client for PyProxy
Author: pyproxytools
License-Expression: MIT
Project-URL: Documentation, https://github.com/pyproxytools/pyproxy/wiki
Project-URL: Issue tracker, https://github.com/pyproxytools/pyproxy/issues
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.8
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: Topic :: Internet
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Classifier: Typing :: Typed
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.31.0
Dynamic: license-file

<div align="center">
  <h1>pyproxy-sdk-py</h1>
</div>


**pyproxy-sdk-py** is a Python library that allows you to interact with the Pyproxy API. It is useful for retrieving data about the proxy or changing its configuration while it is running.

<p align="center">
  <img src="https://img.shields.io/github/license/pyproxytools/pyproxy-sdk-py?style=for-the-badge">
  <img src="https://img.shields.io/github/issues/pyproxytools/pyproxy-sdk-py?style=for-the-badge">
  <img src="https://img.shields.io/github/issues-closed/pyproxytools/pyproxy-sdk-py?style=for-the-badge">
  <br>
  <img src="https://img.shields.io/github/forks/pyproxytools/pyproxy-sdk-py?style=for-the-badge">
  <img src="https://img.shields.io/github/stars/pyproxytools/pyproxy-sdk-py?style=for-the-badge">
  <img src="https://img.shields.io/github/commit-activity/w/pyproxytools/pyproxy-sdk-py?style=for-the-badge">
  <img src="https://img.shields.io/github/contributors/pyproxytools/pyproxy-sdk-py?style=for-the-badge">
  <br>
  <img src="https://img.shields.io/pypi/v/pyproxytools-sdk?style=for-the-badge">
  <img src="https://img.shields.io/pypi/pyversions/pyproxytools-sdk?style=for-the-badge">
</p>

---

## 📦 **Installation**

### Install from package
```bash
pip install pyproxytools-sdk
```

## 🚀 **Usage Examples**

Simple usage examples are available in the [`examples/`](examples) directory.

They include:

* Initializing the PyProxy client
* Managing filters (add, delete, retrieve)
* Retrieving proxy status and settings
* Handling specific errors

## 📚 **Documentation**
If you encounter any problems, or if you want to use the program in a particular way, I advise you to read the [documentation](https://github.com/pyproxytools/pyproxy-sdk-py/wiki).

## 📄 **License**

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## 🤝 **Contributing**

Contributions are welcome and appreciated! If you'd like to improve this project, feel free to fork the repository and submit a pull request. Whether it's fixing bugs, adding new features, improving documentation, or suggesting enhancements, every bit helps. Please make sure to follow the coding standards and test your changes before submitting. Let's build something great together!

---
