Skip to content

Commit

Permalink
python sdk upload
Browse files Browse the repository at this point in the history
  • Loading branch information
nextcaptcha committed Mar 14, 2024
0 parents commit b81ffb4
Show file tree
Hide file tree
Showing 8 changed files with 642 additions and 0 deletions.
38 changes: 38 additions & 0 deletions .github/workflows/publish-to-pypi.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Publish to PyPI
on: push
jobs:
build-n-publish:
name: Build and publish to PyPI
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: Set up Python 3.10
uses: actions/setup-python@v3
with:
python-version: "3.10"
- name: Install pypa/build
run: >-
python -m
pip install
build
--user
- name: Build a binary wheel and a source tarball
run: >-
python -m
build
--sdist
--wheel
--outdir dist/
.
- name: Publish to Test PyPI
continue-on-error: true
uses: pypa/gh-action-pypi-publish@release/v1
with:
password: ${{ secrets.TEST_PYPI_API_TOKEN }}
repository_url: https://test.pypi.org/legacy/
- name: Publish to PyPI
if: startsWith(github.ref, 'refs/tags')
uses: pypa/gh-action-pypi-publish@release/v1
with:
password: ${{ secrets.PYPI_API_TOKEN }}
160 changes: 160 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
*.py,cover
.hypothesis/
.pytest_cache/
cover/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3
db.sqlite3-journal

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
# For a library or package, you might want to ignore these files since the code is
# intended to run in multiple environments; otherwise, check them in:
# .python-version

# pipenv
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
# However, in case of collaboration, if having platform-specific dependencies or dependencies
# having no cross-platform support, pipenv may install dependencies that don't work, or not
# install all needed dependencies.
#Pipfile.lock

# poetry
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
# This is especially recommended for binary packages to ensure reproducibility, and is more
# commonly ignored for libraries.
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
#poetry.lock

# pdm
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
#pdm.lock
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
# in version control.
# https://pdm.fming.dev/#use-with-ide
.pdm.toml

# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json

# Pyre type checker
.pyre/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# PyCharm
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
# and can be added to the global gitignore or merged into this file. For a more nuclear
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
.idea/
8 changes: 8 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
The MIT License (MIT)
Copyright © 2024 NextCaptcha, https://nextcaptcha.com <support@nextcaptcha.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
119 changes: 119 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,119 @@
# NextCaptcha Python SDK
NextCaptcha is a powerful captcha solving service that supports various types of captchas including reCAPTCHA v2,
reCAPTCHA v2 Enterprise, reCAPTCHA v3, reCAPTCHA Mobile, hCaptcha, and FunCaptcha. With NextCaptcha, you can easily
solve a variety of captcha challenges in your automation scripts and programs.

This SDK provides a simple and easy-to-use Python interface for interacting with the NextCaptcha API. It supports all
available captcha types and offers intuitive methods for solving different types of captchas.

## Installation

You can install the NextCaptcha Python SDK using pip:

```shell
pip install nextcaptcha-python
```

## Usage

To start using the NextCaptcha Python SDK, you first need to obtain your API key (clientKey) from the (
NextCaptcha)[https://dashboard.nextcaptcha.com] Dashboard. Then, you can create a NextCaptchaAPI instance:

```python
from nextcaptcha import NextCaptchaAPI

api = NextCaptchaAPI(client_key="YOUR_CLIENT_KEY")
```

Now, you can use the api object to solve various types of captchas.
To solve reCAPTCHA v2 challenges, use the recaptchav2 method:

```python
result = api.recaptchav2(website_url="https://example.com", website_key="SITE_KEY")
```

Solving reCAPTCHA v2 Enterprise
To solve reCAPTCHA v2 Enterprise challenges, use the recaptchav2enterprise method:

```python
result = api.recaptchav2enterprise(website_url="https://example.com", website_key="SITE_KEY")
```

Solving reCAPTCHA v3
To solve reCAPTCHA v3 challenges, use the recaptchav3 method:

```python
result = api.recaptchav3(website_url="https://example.com", website_key="SITE_KEY")
```

Solving reCAPTCHA Mobile
To solve reCAPTCHA Mobile challenges, use the recaptcha_mobile method:

```python
result = api.recaptcha_mobile(app_key="APP_KEY")
```

Solving hCaptcha
To solve hCaptcha challenges, use the hcaptcha method:

```python
result = api.hcaptcha(website_url="https://example.com", website_key="SITE_KEY")
```

Solving hCaptcha Enterprise
To solve hCaptcha Enterprise challenges, use the hcaptcha_enterprise method:

```python
result = api.hcaptcha_enterprise(website_url="https://example.com", website_key="SITE_KEY")
```

Solving FunCaptcha
To solve FunCaptcha challenges, use the funcaptcha method:

```python
result = api.funcaptcha(website_public_key="WEBSITE_PUBLIC_KEY")
```

Checking Account Balance
To check your NextCaptcha account balance, use the get_balance method:

```python
balance = api.get_balance()
print(f"Account balance: {balance}")
```

Here is a complete example of using the NextCaptcha Python SDK to solve a reCAPTCHA v2 challenge:

```python
from nextcaptcha import NextCaptchaAPI

CLIENT_KEY = "YOUR_CLIENT_KEY"
WEBSITE_URL = "https://example.com"
WEBSITE_KEY = "SITE_KEY"

api = NextCaptchaAPI(client_key=CLIENT_KEY)
result = api.recaptchav2(website_url=WEBSITE_URL, website_key=WEBSITE_KEY)

if result["status"] == "ready":
print(f"reCAPTCHA solved: {result['solution']}")
else:
print(f"Failed to solve reCAPTCHA: {result['error']}")
```

## Error Handling

If an error occurs while solving a captcha, the SDK will return a dictionary containing the error information. You can
check the status field to determine if the request was successful. If the status is "ready", the captcha has been
successfully solved and the solution will be provided in the solution field. If the status is "failed", the error field
will contain a description of the error.

## Contributing

If you find any bugs or have suggestions for improvement, please feel free to submit an issue or send a pull request. We
welcome all contributions!

## License

This project is licensed under the MIT License. For more information, please see the LICENSE file.


6 changes: 6 additions & 0 deletions nextcaptcha/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@

from .next import NextCaptchaAPI



__version__ = '1.0.0'

0 comments on commit b81ffb4

Please sign in to comment.