Metadata-Version: 2.1
Name: EasyFlaskRecaptcha
Version: 1.0.2
Summary: Easy Integration of Google Recaptcha in Flask
Home-page: https://github.com/pushpenderindia/EasyFlaskRecaptcha
Author: Pushpender Singh
Author-email: pushpendersingh@protonmail.com
License: MIT License
Keywords: flaskrecaptcha,flask,recaptcha,google,python
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests
Requires-Dist: MarkupSafe

# EasyFlaskRecaptcha
EasyFlaskRecaptcha is a python Module which makes Google Recaptcha Integration in flask application easy

## Installation

```
pip install EasyFlaskRecaptcha
```

### Implementation
```
from flask import Flask
from EasyFlaskRecaptcha import ReCaptcha

app = Flask(__name__)
recaptcha = ReCaptcha(app)

app.config.update(dict(
    GOOGLE_RECAPTCHA_ENABLED=True,
    GOOGLE_RECAPTCHA_SITE_KEY="6Lf74pUpXXXXXXXXXXXXXXXi012KXXXX7KB-31XXXH",
    GOOGLE_RECAPTCHA_SECRET_KEY="6LXXXXXXXXXXAFX-ZAXXXXXGSd-y5g0o-JZXXXXB"
))
recaptcha.init_app(app)
```
    
## Flask Template Usage Example (Frontend)
```
Description: Use {{ recaptcha }} Tag inside form tag
```

```
<form method="post" action="/submit">
    ...
    {{ recaptcha }}

    [submit]
</form>
```

## Flask Backend Route Example
```
@route("/submit", methods=["POST"])
def submit():
    if recaptcha.verify():
        print("SUCCESS") 
            
    else:
        print("FAILED")
```

## Default Settings
```
GOOGLE_RECAPTCHA_ENABLED = True
GOOGLE_RECAPTCHA_THEME = "light"
GOOGLE_RECAPTCHA_TYPE = "image"
GOOGLE_RECAPTCHA_SIZE = "normal"
GOOGLE_RECAPTCHA_LANGUAGE = "en"
GOOGLE_RECAPTCHA_TABINDEX = 0
```

## More Settings

```
GOOGLE_RECAPTCHA_ENABLED = True
GOOGLE_RECAPTCHA_SITE_KEY = ""
GOOGLE_RECAPTCHA_SECRET_KEY = ""
GOOGLE_RECAPTCHA_THEME = "light"
GOOGLE_RECAPTCHA_TYPE = "image"
GOOGLE_RECAPTCHA_SIZE = "normal"
GOOGLE_RECAPTCHA_LANGUAGE = "en"
GOOGLE_RECAPTCHA_TABINDEX = 10
```

Apply these settings like this:
```
from flask import Flask
from EasyFlaskRecaptcha import ReCaptcha

app = Flask(__name__)
recaptcha = ReCaptcha(app)

app.config.update(dict(
    GOOGLE_RECAPTCHA_ENABLED=True,
    GOOGLE_RECAPTCHA_SITE_KEY="6Lf74pUpXXXXXXXXXXXXXXXi012KXXXX7KB-31XXXH",
    GOOGLE_RECAPTCHA_SECRET_KEY="6LXXXXXXXXXXAFX-ZAXXXXXGSd-y5g0o-JZXXXXB",
    GOOGLE_RECAPTCHA_THEME = "light",
    GOOGLE_RECAPTCHA_TYPE = "image",
    GOOGLE_RECAPTCHA_SIZE = "normal",
    GOOGLE_RECAPTCHA_LANGUAGE = "en",
    GOOGLE_RECAPTCHA_RTABINDEX = 10,
))
recaptcha.init_app(app)
```

- Figure out your desired language code (such as for english, language code is en) from this link: [Google Recaptcha Language Codes](https://developers.google.com/recaptcha/docs/language)
- Set this parameter: `GOOGLE_RECAPTCHA_LANGUAGE = "en"`

## Link:

* [Google Recaptcha Language Codes](https://developers.google.com/recaptcha/docs/language)
* [Documentation](https://github.com/PushpenderIndia/EasyFlaskRecaptcha)
* [PyPI](https://pypi.org/project/EasyFlaskRecaptcha/)

## License

This project is licensed under the MIT License (see the `LICENSE` file for details).
