.. proxycheck documentation master file, created by
   sphinx-quickstart on Tue Nov 10 13:12:46 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to ProxyCheck.io's unofficial documentation!
====================================================

This is a unofficial asynchronous & synchronous wrapper for ProxyCheck.io API.

**Features:**

- Full API coverage.
- Asynchronous & synchronous support.
- Easy to use with an object oriented design.
- 100% test coverage.

Install
-------

Pip: ::

      pip3 install proxycheck

Git: ::

      pip3 install git+https://github.com/WardPearce/proxycheck.git

Documentation Contents
-----------------------
.. toctree::
   :maxdepth: 3

   intro
   models
   api
   exceptions


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`