The working Google ReCaptcha implementation for Flask without Flask-WTF
Project description
Flask Google ReCaptcha
The Working Google ReCaptcha implementation for Flask without Flask-WTF.
Can also be used as standalone
Install
pip install Flask-GoogleReCaptcha
# or
pip install git+https://github.com/AndersonFirmino/flask-google-recaptcha.git
If you are using pipenv
pipenv install Flask-GoogleReCaptcha
This implementation is pure and has no dependencies from third parties. Works in both Python2 and Python3. You can use it in any flask project.
Has Google App Engine (GAE) support!
Usage
Implementation view.py
from flask import Flask
from flask_google_recaptcha import GoogleReCaptcha
app = Flask(__name__)
recaptcha = GoogleReCaptcha(app=app)
# or
recaptcha = GoogleReCaptcha()
recaptcha.init_app(app)
In your template: {{ recaptcha }}
Inside of the form you want to protect, include the tag: {{ recaptcha }}
It will insert the code automatically
<form method="post" action="/submit">
... your field
... your field
{{ recaptcha }}
[submit button]
</form>
Verify the captcha
In the view that's going to validate the captcha
from flask import Flask
from flask_google_recaptcha import GoogleReCaptcha
app = Flask(__name__)
recaptcha = GoogleReCaptcha(app=app)
@route("/submit", methods=["POST"])
def submit():
if recaptcha.verify():
# SUCCESS
pass
else:
# FAILED
pass
Remember to set SITE_KEY and SECRET_KEY if not it does not appear!
Api
reCaptcha.init(app, site_key, secret_key, is_enabled=True)
reCaptcha.get_code()
Returns the HTML code to implement. But you can use {{ recaptcha }} directly in your template
reCaptcha.verfiy()
Returns bool
In Template
Just include {{ recaptcha }} wherever you want to show the recaptcha
Config
Flask-ReCaptcha is configured through the standard Flask config API. These are the available options:
RECAPTCHA_ENABLED: Bool - True by default, when False it will bypass validation
RECAPTCHA_SITE_KEY : Public key
RECAPTCHA_SECRET_KEY: Private key
The following are Optional arguments.
RECAPTCHA_THEME: String - Theme can be 'light'(default) or 'dark'
RECAPTCHA_TYPE: String - Type of recaptcha can be 'image'(default) or 'audio'
RECAPTCHA_SIZE: String - Size of the image can be 'normal'(default) or 'compact'
RECAPTCHA_TABINDEX: Int - Tabindex of the widget can be used, if the page uses tabidex, to make navigation easier. Defaults to 0
RECAPTCHA_ENABLED = True
RECAPTCHA_SITE_KEY = ""
RECAPTCHA_SECRET_KEY = ""
RECAPTCHA_THEME = "dark"
RECAPTCHA_TYPE = "image"
RECAPTCHA_SIZE = "compact"
RECAPTCHA_RTABINDEX = 10
Google App Engine Standard implementation
To run this package with flask on App Engine Standard clone this repo to your ptoject folder Your project structure should look like this:
FlaskProjectFolder
|-flask_google_recaptcha
| |-__init__.py
|-main.py (main flask app)
...
If your flask project folder looks like as shown above, all the imports stated previously stay the same :cake:
Anderson Araujo (coderpy) :snake:
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
Hashes for Flask_GoogleRecaptcha-0.5.7-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2b9c4335d49bfd3c17df2b924278a6afdfd77846f707fcb4a9c455b3802d7ded |
|
MD5 | 1d528242d73c99b3eafd978c30958c58 |
|
BLAKE2b-256 | 16d3478f79179fa86757e59fa09ff644784e0504bdd8af57572791ecb56bff6c |