Merge pull request #20 from AndreiDrang/main

Upd images

Author: Andrei

.github/workflows/sphinx.yml

@@ -21,10 +21,7 @@ jobs:
         run: pip install -r src/requirements.txt
 
       - name: Build docs
-        run: | 
-          cd docs/ && \
-          pip install -r requirements.txt && \
-          make html -e
+        run: make doc
 
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3

Makefile

@@ -35,4 +35,4 @@ tests:
 
 doc:
 	cd docs/ && \
-	make html
+	make html -e

README.md

@@ -15,7 +15,7 @@
 [![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)
 
 
-Python3 library for [Capsolver](https://capsolver.com/) service API.
+Python 3 library for [Capsolver](https://capsolver.com/) service API.
 
 Tested on UNIX based OS.
 
@@ -29,11 +29,33 @@ Or email python-captcha@pm.me
 
 ***
 
+## How to install?
+
+We recommend using the latest version of Python. `python3-captchaai` supports Python 3.7+.
+
+### pip
+
+```bash
+pip install python3-captchaai
+```
+
+### Source
+```bash
+git clone https://github.com/AndreiDrang/python3-captchaai.git
+cd python3-captchaai
+python setup.py install
+```
+
+## How to test?
+
+1. You need set ``API_KEY`` in your environment(get this value from you account).
+2. Run command ``make tests``, from root directory.
+
 ### Additional info
 1. [Library usage examples && Docs](https://andreidrang.github.io/python3-captchaai/)
 2. [Capsolver errors list](https://captchaai.atlassian.net/wiki/spaces/CAPTCHAAI/pages/426145/)
 
 
-### Get API Key to work with the library
+### How to get API Key to work with the library
 1. On the page - https://dashboard.capsolver.com/overview/user-center
 2. Find it: ![img.png](files/img.png)

docs/conf.py

@@ -1,18 +1,8 @@
-# Configuration file for the Sphinx documentation builder.
-#
-# This file only contains a selection of the most common options. For a full
-# list see the documentation:
-# https://www.sphinx-doc.org/en/master/usage/configuration.html
-
 # -- Path setup --------------------------------------------------------------
 
 import os
 import sys
 
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
 from pallets_sphinx_themes import ProjectLink
 
 os.chdir("../")

docs/modules/main/info.md

@@ -26,8 +26,7 @@ The library is intended for software developers and is used to work with the [Ca
 
 ## How to install?
 
-We recommend using the latest version of Python. `python3-captchaai` supports Python
-3.7+.
+We recommend using the latest version of Python. `python3-captchaai` supports Python 3.7+.
 
 ### pip
 

files/img.png

@@ -1 +1 @@
-__version__ = "0.5.1"
+__version__ = "0.5.2"

src/python3_captchaai/__version__.py

@@ -115,7 +115,7 @@ def _create_task(self, url_postfix: str = EndpointPostfixEnm.CREATE_TASK.value)
 
     def _get_result(self, url_postfix: str = EndpointPostfixEnm.GET_TASK_RESULT.value) -> CaptchaResponseSer:
         """
-        Function send SYNC request to service and wait for result
+        Method send SYNC request to service and wait for result
         """
         # initial waiting
         time.sleep(self.__params.sleep_time)

src/python3_captchaai/core/base.py

@@ -95,13 +95,13 @@ class ResponseStatusEnm(str, MyEnum):
 
 class ProxyType(str, MyEnum):
     """
-    Enum store results `status` field variants
+    Enum store proxy types
 
     Notes:
         https://captchaai.atlassian.net/wiki/spaces/CAPTCHAAI/pages/426124
     """
 
     http = "http"  # usual http / https
-    https = "https"  # try this only if "http" doesn't work (required by some custom proxy servers)
+    https = "https"
     socks4 = "socks4"
     socks5 = "socks5"

src/python3_captchaai/core/enum.py

@@ -20,7 +20,7 @@ class TaskSer(BaseModel):
 
 class RequestCreateTaskSer(PostRequestSer):
     task: Optional[TaskSer] = Field(None, description="Task object")
-    appId: str = Field(APP_ID, description="AppID")
+    appId: str = Field(APP_ID, description="AppID", const=True)
 
 
 class RequestGetTaskResultSer(PostRequestSer):