0.0.7a

.github/workflows/install.yml

@@ -0,0 +1,36 @@
+name: Installation
+
+on:
+  push:
+    branches: [ "main", "release"]
+    paths:
+      - '.github/workflows/install.yml'
+      - 'src/**'
+      - 'Makefile'
+  pull_request:
+    branches: [ "main", "release"]
+    paths:
+      - '.github/workflows/install.yml'
+      - 'src/**'
+      - 'Makefile'
+
+jobs:
+  install:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Local install checking
+      run: make install
+
+    - name: PYPI install checking
+      run: pip install python3-captchaai

.github/workflows/python-package.yml → .github/workflows/lint.yml

@@ -1,20 +1,30 @@
-name: Library lint and test
+name: Lint
 
 on:
   push:
-    branches: [ "main" ]
+    branches: [ "main", "release"]
+    paths:
+      - '.github/workflows/lint.yml'
+      - 'src/**'
+      - 'Makefile'
+      - 'requirements.style.txt'
   pull_request:
-    branches: [ "main" ]
+    branches: [ "main", "release"]
+    paths:
+      - '.github/workflows/lint.yml'
+      - 'src/**'
+      - 'Makefile'
+      - 'requirements.style.txt'
 
 jobs:
-  build:
+  lint:
     runs-on: ubuntu-latest
     env:
       API_KEY: ${{ secrets.API_KEY }}
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.6", "3.7", "3.8", "3.9", "3.10"]
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
 
     steps:
     - uses: actions/checkout@v3
@@ -27,12 +37,6 @@ jobs:
       run: |
         pip install --upgrade pip
         pip install -r requirements.style.txt
-        pip install -r requirements.test.txt
-        pip install -r src/requirements.txt
 
     - name: Lint
-      run: |
-        make lint
-    - name: Test
-      run: |
-        make tests
+      run: make lint

.github/workflows/sphinx.yml

@@ -0,0 +1,35 @@
+name: Sphinx build
+
+on:
+  push:
+    branches: [ "release" ]
+    paths:
+      - '.github/workflows/sphinx.yml'
+      - 'src/**'
+      - 'docs/**'
+      - 'files/**'
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v3
+
+      - name: Build library requirements
+        run: pip install -r src/requirements.txt
+
+      - name: Build docs
+        run: | 
+          cd docs/ && \
+          pip install -r requirements.txt && \
+          make html -e
+
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          publish_branch: gh-pages
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs/_build/html/
+          force_orphan: true

.github/workflows/test.yml

@@ -0,0 +1,65 @@
+name: Tests
+
+on:
+  push:
+    branches: [ "main", "release"]
+    paths:
+      - '.github/workflows/test.yml'
+      - 'src/**'
+      - 'Makefile'
+      - 'requirements.test.txt'
+  pull_request:
+    branches: [ "main", "release"]
+    paths:
+      - '.github/workflows/test.yml'
+      - 'src/**'
+      - 'Makefile'
+      - 'requirements.test.txt'
+  schedule:
+    - cron: "5 0 * * 1"
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    env:
+      API_KEY: ${{ secrets.API_KEY }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install -r requirements.test.txt
+          pip install -r src/requirements.txt
+
+      - name: Test
+        run: make tests
+
+      - name: Coveralls Parallel
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          path-to-lcov: ./src/coverage/lcov.info
+          flag-name: Pytests
+          parallel: true
+
+  finish:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+    - name: Coveralls Finished
+      uses: coverallsapp/github-action@master
+      with:
+        parallel-finished: true
+        github-token: ${{ secrets.GITHUB_TOKEN }}
+        path-to-lcov: ./src/coverage/lcov.info
+        flag-name: Pytests

.github/workflows/test_build.yml

@@ -0,0 +1,35 @@
+name: Test Build
+
+on:
+  push:
+    branches: [ "main", "release"]
+    paths:
+      - '.github/workflows/test_build.yml'
+      - 'src/**'
+      - 'Makefile'
+  pull_request:
+    branches: [ "main", "release"]
+    paths:
+      - '.github/workflows/test_build.yml'
+      - 'src/**'
+      - 'Makefile'
+
+jobs:
+  test_build:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.7", "3.8", "3.9", "3.10"]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Local build checking
+      run: |
+        pip install twine wheel
+        cd src/ && python setup.py sdist bdist_wheel

.gitignore

@@ -20,3 +20,7 @@ env/
 /.coverage
 /src/python3_captchaai.egg-info/
 /src/.coverage
+/src/coverage/lcov.info
+/src/htmlcov/
+/src/coverage/
+/docs/_build/

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Andrei
+Copyright (c) 2022 Andrei
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Makefile

@@ -1,24 +1,26 @@
 install:
-	python setup.py install
-
-remove:
-	pip uninstall python_rucaptcha -y
+	cd src/ && pip install -e .
 
 refactor:
+	black docs/
+	isort docs/
+
+	cd src/ && \
 	autoflake --in-place \
 				--recursive \
 				--remove-unused-variables \
 				--remove-duplicate-keys \
 				--remove-all-unused-imports \
 				--ignore-init-module-imports \
-				src/
-	black src/
-	isort src/
+				python3_captchaai/ tests/ && \
+	black python3_captchaai/ tests/ && \
+	isort python3_captchaai/ tests/
 
 lint:
-	autoflake --in-place --recursive src/ --check
-	black src/ --check
-	isort src/ --check-only
+	cd src/ && \
+	autoflake --in-place --recursive python3_captchaai/ --check && \
+	black python3_captchaai/ --check && \
+	isort python3_captchaai/ --check-only
 
 upload:
 	pip install twine
@@ -27,4 +29,6 @@ upload:
 tests:
 	cd src/ && \
 	coverage run --rcfile=.coveragerc -m pytest -s tests -vv --disable-warnings && \
-	coverage report --precision=3 --sort=cover -m
+	coverage report --precision=3 --sort=cover --skip-empty --show-missing && \
+	coverage html --precision=3 --skip-empty && \
+	coverage lcov -o coverage/lcov.info

README.md

@@ -1,38 +1,34 @@
 # python3-captchaai
+![](files/CaptchaAISm.png)
 
 [![PyPI version](https://badge.fury.io/py/python3-captchaai.svg)](https://badge.fury.io/py/python3-captchaai)
 [![Python versions](https://img.shields.io/pypi/pyversions/python3-captchaai.svg?logo=python&logoColor=FBE072)](https://badge.fury.io/py/python3-captchaai)
+[![Downloads](https://pepy.tech/badge/python3-captchaai/month)](https://pepy.tech/project/python3-captchaai)
+
 [![Maintainability](https://api.codeclimate.com/v1/badges/3431fd3fe71baf7eb9da/maintainability)](https://codeclimate.com/github/AndreiDrang/python3-captchaai/maintainability)
 
-The library is intended for software developers and serves to facilitate work with the CaptchaAI service API.
+[![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)
+[![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)
+[![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)
+[![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)
 
-***
-If you have any questions, please write to [Telegram](https://t.me/pythoncaptcha) chat. 
-Or to [email](python-captcha@pm.me).
 
-## How to install?
+Python3 library for [CaptchaAI](https://www.captchaai.io/) service API.
 
-### pip
+Tested on UNIX based OS.
 
-```bash
-pip install python3-captchaai
-```
+The library is intended for software developers and is used to work with the [CaptchaAI](https://www.captchaai.io/) service API.
 
-### Source
-```bash
-git clone https://github.com/AndreiDrang/python3-captchaai.git
-cd python3-captchaai
-python setup.py install
-```
+***
 
-### Changelog
+If you have any questions, please send a message to the [Telegram](https://t.me/pythoncaptcha) chat room.
 
-v.0.0.1 - First release with basic methods and logic.
+Or email python-captcha@pm.me
 
 ***
 
 ### Additional info
-1. [All examples of working with the library](src/examples)
+1. [Library usage examples](https://andreidrang.github.io/python3-captchaai/)
 2. [CaptchaAI errors list](https://captchaai.atlassian.net/wiki/spaces/CAPTCHAAI/pages/426145/errorCode+full+list+of+errors)
 
 

docs/Makefile

@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)