Skip to content

Commit ccb8e15

Browse files
author
Andrei
committed
upd docs
1 parent bc91990 commit ccb8e15

4 files changed

Lines changed: 43 additions & 18 deletions

File tree

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,11 @@ Is described in the [documentation-website](https://andreidrang.github.io/python
5252
1. You need set ``API_KEY`` in your environment(get this value from you account).
5353
2. Run command ``make tests``, from root directory.
5454

55+
56+
### Changelog
57+
58+
Check [releases page](https://github.com/AndreiDrang/python3-capsolver/releases).
59+
5560
### How to get API Key to work with the library
5661
1. On the page - https://dashboard.capsolver.com/overview/user-center
5762
2. Find it: ![img.png](files/img.png)
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Cloudflare
2+
==========
3+
4+
To import this module:
5+
6+
.. code-block:: python
7+
8+
from python3_capsolver.cloudflare import Cloudflare
9+
10+
11+
.. autoclass:: python3_capsolver.cloudflare.Cloudflare
12+
:members:

docs/modules/main/info.md

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,47 +1,55 @@
11
# Introduction
22

3-
## Welcome to python3-captchaai
3+
## Welcome to python3-capsolver
44

55
![](../../_static/CapsolverSM.png)
66

7-
[![PyPI version](https://badge.fury.io/py/python3-captchaai.svg)](https://badge.fury.io/py/python3-captchaai)
8-
[![Python versions](https://img.shields.io/pypi/pyversions/python3-captchaai.svg?logo=python&logoColor=FBE072)](https://badge.fury.io/py/python3-captchaai)
9-
[![Downloads](https://pepy.tech/badge/python3-captchaai/month)](https://pepy.tech/project/python3-captchaai)
7+
[![Capsolver](https://user-images.githubusercontent.com/16991365/234852229-6e4b3f3c-f498-4fd5-9a6b-f7f269dd4bfc.gif)](https://dashboard.capsolver.com/passport/register?inviteCode=kQTn-tG07Jb1)
108

11-
[![Maintainability](https://api.codeclimate.com/v1/badges/3431fd3fe71baf7eb9da/maintainability)](https://codeclimate.com/github/AndreiDrang/python3-captchaai/maintainability)
12-
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/323d4eda0fe1477bbea8fe8902b9e97e)](https://www.codacy.com/gh/AndreiDrang/python3-captchaai/dashboard?utm_source=github.com&utm_medium=referral&utm_content=AndreiDrang/python3-captchaai&utm_campaign=Badge_Grade)
13-
[![codecov](https://codecov.io/gh/AndreiDrang/python3-captchaai/branch/main/graph/badge.svg?token=2L4VVIF4G8)](https://codecov.io/gh/AndreiDrang/python3-captchaai)
9+
[![PyPI version](https://badge.fury.io/py/python3-capsolver.svg)](https://badge.fury.io/py/python3-capsolver)
10+
[![Python versions](https://img.shields.io/pypi/pyversions/python3-capsolver.svg?logo=python&logoColor=FBE072)](https://badge.fury.io/py/python3-capsolver)
11+
[![Downloads](https://pepy.tech/badge/python3-capsolver/month)](https://pepy.tech/project/python3-capsolver)
1412

15-
[![Build check](https://github.com/AndreiDrang/python3-captchaai/actions/workflows/test_build.yml/badge.svg?branch=main)](https://github.com/AndreiDrang/python3-captchaai/actions/workflows/test_build.yml)
16-
[![Installation check](https://github.com/AndreiDrang/python3-captchaai/actions/workflows/install.yml/badge.svg?branch=main)](https://github.com/AndreiDrang/python3-captchaai/actions/workflows/install.yml)
17-
[![Test](https://github.com/AndreiDrang/python3-captchaai/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/AndreiDrang/python3-captchaai/actions/workflows/test.yml)
18-
[![Lint](https://github.com/AndreiDrang/python3-captchaai/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/AndreiDrang/python3-captchaai/actions/workflows/lint.yml)
13+
[![Maintainability](https://api.codeclimate.com/v1/badges/3c30167b5fb37a0775ea/maintainability)](https://codeclimate.com/github/AndreiDrang/python3-capsolver/maintainability)
14+
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/323d4eda0fe1477bbea8fe8902b9e97e)](https://www.codacy.com/gh/AndreiDrang/python3-capsolver/dashboard?utm_source=github.com&utm_medium=referral&utm_content=AndreiDrang/python3-capsolver&utm_campaign=Badge_Grade)
15+
[![codecov](https://codecov.io/gh/AndreiDrang/python3-capsolver/branch/main/graph/badge.svg?token=2L4VVIF4G8)](https://codecov.io/gh/AndreiDrang/python3-capsolver)
1916

17+
[![Sphinx build](https://github.com/AndreiDrang/python3-capsolver/actions/workflows/sphinx.yml/badge.svg?branch=release)](https://github.com/AndreiDrang/python3-capsolver/actions/workflows/sphinx.yml)
18+
[![Build](https://github.com/AndreiDrang/python3-capsolver/actions/workflows/build.yml/badge.svg?branch=main)](https://github.com/AndreiDrang/python3-capsolver/actions/workflows/build.yml)
19+
[![Installation](https://github.com/AndreiDrang/python3-capsolver/actions/workflows/install.yml/badge.svg?branch=main)](https://github.com/AndreiDrang/python3-capsolver/actions/workflows/install.yml)
20+
[![Tests](https://github.com/AndreiDrang/python3-capsolver/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/AndreiDrang/python3-capsolver/actions/workflows/test.yml)
21+
[![Lint](https://github.com/AndreiDrang/python3-capsolver/actions/workflows/lint.yml/badge.svg?branch=main)](https://github.com/AndreiDrang/python3-capsolver/actions/workflows/lint.yml)
2022

21-
Python3 library for [Capsolver](https://capsolver.com/) service API.
23+
24+
Python 3 library for [Capsolver](https://dashboard.capsolver.com/passport/register?inviteCode=kQTn-tG07Jb1) service API.
2225

2326
Tested on UNIX based OS.
2427

25-
The library is intended for software developers and is used to work with the [Capsolver](https://capsolver.com/) service API.
28+
The library is intended for software developers and is used to work with the [Capsolver](https://dashboard.capsolver.com/passport/register?inviteCode=kQTn-tG07Jb1) service API.
2629

2730
## How to install?
2831

29-
We recommend using the latest version of Python. `python3-captchaai` supports Python 3.7+.
32+
We recommend using the latest version of Python. `python3-capsolver` supports Python 3.7+.
3033

3134
### pip
3235

3336
```bash
34-
pip install python3-captchaai
37+
pip install python3-capsolver
3538
```
3639

3740
### Source
3841
```bash
39-
git clone https://github.com/AndreiDrang/python3-captchaai.git
40-
cd python3-captchaai
42+
git clone https://github.com/AndreiDrang/python3-capsolver.git
43+
cd python3-capsolver
4144
python setup.py install
4245
```
4346

4447
## How to test?
4548

4649
1. You need set ``API_KEY`` in your environment(get this value from you account).
4750
2. Run command ``make tests``, from root directory.
51+
52+
53+
### Changelog
54+
55+
Check [releases page](https://github.com/AndreiDrang/python3-capsolver/releases).

docs/modules/other-libs/info.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@
33
## Other libraries for Captcha-solving services
44
1. [RuCaptcha / 2Captcha](https://github.com/AndreiDrang/python-rucaptcha)
55
2. [AntiCaptcha](https://github.com/AndreiDrang/python3-anticaptcha)
6-
3. [Capsolver](https://github.com/AndreiDrang/python3-captchaai)
6+
3. [Capsolver](https://github.com/AndreiDrang/python3-capsolver)

0 commit comments

Comments
 (0)