Metadata-Version: 2.4
Name: cap-server-api
Version: 1.0.0
Summary: Python wrapper for Cap CAPTCHA server API
Home-page: https://github.com/relic-se/cap-server-api
Author: Cooper Dalrymple
Author-email: Cooper Dalrymple <me@dcdalrymple.com>
License: GPLv3
Project-URL: Homepage, https://github.com/relic-se/cap-server-api
Keywords: cap,captcha,api,server,wrapper,integration
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
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 :: Only
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Software Development :: Libraries
Description-Content-Type: text/x-rst
License-File: LICENSE
Provides-Extra: optional
Dynamic: author
Dynamic: home-page
Dynamic: license-file

Introduction
============
.. image:: https://readthedocs.org/projects/cap-server-api/badge/?version=latest
    :target: https://cap-server-api.readthedocs.org/en/latest/
    :alt: Documentation Status

.. image:: https://github.com/relic-se/cap-server-api/workflows/Build%20CI/badge.svg
    :target: https://github.com/relic-se/cap-server-api/actions
    :alt: Build Status

.. image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
    :target: https://github.com/astral-sh/ruff
    :alt: Code Style: Ruff

Python API integration library for Cap CAPTCHA server

Installing from PyPI
=====================
To install for current user:

.. code-block:: shell

    pip3 install cap-server-api

To install system-wide (this may be required in some cases):

.. code-block:: shell

    sudo pip3 install cap-server-api

To install in a virtual environment in your current project:

.. code-block:: shell

    mkdir project-name && cd project-name
    python3 -m venv .venv
    source .env/bin/activate
    pip3 install cap-server-api

Usage Example
=============

.. code-block:: python

    from cap_server_api import Server
    server = Server("[serverDomain]", "[apiKey]")
    print(server.about)

Documentation
=============
API documentation for this library can be found on `Read the Docs <https://cap-server-api.readthedocs.org/en/latest/>`_.

Contributing
============
Contributions are welcome!
