<img src="https://raw.github.com/snarfed/oauth-dropins/main/oauth_dropins/static/oauth_shiny.png" alt="OAuth logo" width="125" /> oauth-dropins [](https://circleci.com/gh/snarfed/oauth-dropins)
=============
Drop-in Python [OAuth](http://oauth.net/) for popular sites!
* [About](#about)
* [Quick start](#quick-start)
* [Usage details](#usage-details)
* [Troubleshooting/FAQ](#troubleshootingfaq)
* [Changelog](#changelog)
* [Development](#development)
* [Release instructions](#release-instructions)
About
---
This is a collection of drop-in Python [Flask](https://flask.palletsprojects.com/) views for the initial [OAuth](http://oauth.net/) client flows for many popular sites, including Blogger, Disqus, Dropbox, Facebook, Flickr, GitHub, Google, IndieAuth, Instagram, LinkedIn, Mastodon, Medium, Tumblr, Twitter, and WordPress.com.
oauth-dropins stores user credentials in [Google Cloud Datastore](https://cloud.google.com/datastore/). It's primarily designed for [Google App Engine](https://appengine.google.com/), but it can be used in any Python web application, regardless of host or framework.
* [Available on PyPi.](https://pypi.python.org/pypi/oauth-dropins/) Install with `pip install oauth-dropins`.
* [Getting started docs.](#quick-start)
* [Reference docs.](https://oauth-dropins.readthedocs.io/en/latest/source/oauth_dropins.html)
* Demo app at [oauth-dropins.appspot.com](http://oauth-dropins.appspot.com/).
* [Source code on GitHub.](https://github.com/snarfed/oauth-dropins/)
This software is released into the public domain. See LICENSE for details.
Quick start
---
Here's a full example of using the GitHub drop-in.
1. Install oauth-dropins with `pip install oauth-dropins`.
1. Put your [GitHub OAuth application's](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app) ID and secret in two plain text files in your app's root directory, `github_client_id` and `github_client_secret`. (If you use git, you'll probably also want to add them to your `.gitignore`.)
1. Create a `github_oauth.py` file with these contents:
```python
from oauth_dropins import github
from app import app # ...or wherever your Flask app is
app.add_url_rule('/start',
view_func=github.Start.as_view('start', '/callback'),
methods=['POST'])
app.add_url_rule('/callback',
view_func=github.Callback.as_view('callback', '/after'))
```
Voila! Send your users to `/github/start` when you want them to connect their GitHub account to your app, and when they're done, they'll be redirected to `/after?access_token=...` in your app.
All of the sites provide the same API. To use a different one, just import the site module you want and follow the same steps. The filenames for app keys and secrets also differ by site; see each site's `.py` file for its filenames.
Usage details
---
There are three main parts to an OAuth drop-in: the initial redirect to the site itself, the redirect back to your app after the user approves or declines the request, and the datastore entity that stores the user's OAuth credentials and helps you use them. These are implemented by [`Start`](#start) and [`Callback`](#callback), which are [Flask](https://flask.palletsprojects.com/) [View](https://flask.palletsprojects.com/en/2.0.x/api/#flask.views.View) classes, and [auth entities](#auth-entities), which are [Google Cloud Datastore](https://cloud.google.com/datastore/) [ndb models](https://googleapis.dev/python/python-ndb/latest/model.html).
### `Start`
This view class redirects you to an OAuth-enabled site so it can ask the user to grant your app permission. It has two useful methods:
- The constructor, `__init__(self, to_path, scopes=None)`. `to_path` is the OAuth callback, ie URL path on your site that the site's OAuth flow should redirect back to after it's done. This is handled by a [`Callback`](#callback) view in your application, which needs to handle the `to_path` route.
If you want to add OAuth scopes beyond the default one(s) needed for login, you can pass them to the `scopes` kwarg as a string or sequence of strings, or include them in the `scopes` query parameter in the POST request body. This is supported in most sites, but not all.
Some OAuth 1 sites support alternatives to scopes. For Twitter, the `Start` constructor takes an additional `access_type` kwarg that may be `read` or `write`. It's passed through to Twitter [`x_auth_access_type`](https://dev.twitter.com/docs/api/1/post/oauth/request_token). For Flickr, `Start` accepts a `perms` POST query parameter that may be `read`, `write` or `delete`; it's [passed through to Flickr](https://www.flickr.com/services/api/auth.oauth.html#authorization) unchanged. (Flickr claims it's optional, but [sometimes breaks if it's not provided.](http://stackoverflow.com/questions/6517317/flickr-api-error-when-oauth))
- `redirect_url(state=None)` returns the URL to redirect to at the site to initiate the OAuth flow. `Start` will redirect here automatically if it's used in a WSGI application, but you can call this manually if you want to control that redirect yourself:
```python
import flask
class MyView(Start):
def dispatch_request(self):
...
flask.redirect(self.redirect_url())
```
### `Callback`
This class handles the HTTP redirect back to your app after the user has granted or declined permission. It also has two useful methods:
- The constructor, `__init__(self, to_path, scopes=None)`. `to_path` is the URL path on your site that users should be redirected to after the callback view is done. It will include a `state` query parameter with the value provided to `Start`. It will also include an OAuth token in its query parameters, either `access_token` for OAuth 2.0 or `access_token_key` and `access_token_secret` for OAuth 1.1. It will also include an `auth_entity` query parameter with the string key of an [auth entity](#auth-entities) that has more data (and functionality) for the authenticated user. If the user declined the OAuth authorization request, the only query parameter besides `state` will be `declined=true`.
- `finish(auth_entity, state=None)` is run in the initial callback request after the OAuth response has been processed. `auth_entity` is the newly created auth entity for this connection, or `None` if the user declined the OAuth authorization request.
By default, `finish` redirects to `to_path`, but you can subclass `Callback` and override it to run your own code instead of redirecting:
```python
class MyCallback(github.Callback):
def finish(self, auth_entity, state=None):
super().finish(auth_entity, state=state) # ignore returned redirect
self.response.write('Hi %s, thanks for connecting your %s account.' %
(auth_entity.user_display_name(), auth_entity.site_name()))
```
### Auth entities
Each site defines a Google Cloud Datastore [ndb.Model class](https://developers.google.com/appengine/docs/python/datastore/entities#Python_Kinds_and_identifiers) that stores each user's OAuth credentials and other useful information, like their name and profile URL. The class name is generally of the form <em>Site</em>Auth, e.g. `GitHubAuth`. Here are the useful methods:
- `site_name()` returns the human-readable string name of the site, e.g. "Facebook".
- `user_display_name()` returns a human-readable string name for the user, e.g. "Ryan Barrett". This is usually their first name, full name, or username.
- `access_token()` returns the OAuth access token. For OAuth 2 sites, this is a single string. For OAuth 1.1 sites (currently just Twitter, Tumblr, and Flickr), this is a `(string key, string secret)` tuple.
The following methods are optional. Auth entity classes usually implement at least one of them, but not all.
- `api()` returns a site-specific API object. This is usually a third party library dedicated to the site, e.g. [Tweepy](https://github.com/tweepy/tweepy) or [python-instagram](https://github.com/Instagram/python-instagram). See the site class's docstring for details.
- `urlopen(data=None, timeout=None)` wraps `urlopen()` and adds the OAuth credentials to the request. Use this for making direct HTTP request to a site's REST API. Some sites may provide `get()` instead, which wraps `requests.get()`.
Troubleshooting/FAQ
---
1. If you get this error:
```
bash: ./bin/easy_install: ...bad interpreter: No such file or directory
```
You've probably hit [this virtualenv bug](https://github.com/pypa/virtualenv/issues/53): virtualenv doesn't support paths with spaces.
The easy fix is to recreate the virtualenv in a path without spaces. If you can't do that, then after creating the virtualenv, but before activating it, edit the activate, easy_install and pip files in `local/bin/` to escape any spaces in the path.
For example, in `activate`, `VIRTUAL_ENV=".../has space/local"` becomes `VIRTUAL_ENV=".../has\ space/local"`, and in `pip` and `easy_install` the first line changes from `#!".../has space/local/bin/python"` to `#!".../has\ space/local/bin/python"`.
This should get virtualenv to install in the right place. If you do this wrong at first, you'll have installs in eg `/usr/local/lib/python3.7/site-packages` that you need to delete, since they'll prevent virtualenv from installing into the local `site-packages`.
1. If you see errors importing or using `tweepy`, it may be because `six.py` isn't installed. Try `pip install six` manually. `tweepy` does include `six` in its dependencies, so this shouldn't be necessary. Please [let us know](https://github.com/snarfed/oauth-dropins/issues) if it happens to you so we can debug!
1. If you get an error like this:
```
Running setup.py develop for gdata
...
error: option --home not recognized
...
InstallationError: Command /usr/bin/python -c "import setuptools, tokenize; __file__='/home/singpolyma/src/bridgy/src/gdata/setup.py'; exec(compile(getattr(tokenize, 'open', open)(__file__).read().replace('\r\n', '\n'), __file__, 'exec'))" develop --no-deps --home=/tmp/tmprBISz_ failed with error code 1 in .../src/gdata
```
...you may be hitting [Pip bug 1833](https://github.com/pypa/pip/issues/1833). Are you passing `-t` to `pip install`? Use the virtualenv instead, it's your friend. If you really want `-t`, try removing the `-e` from the lines in `requirements.txt` that have it.
Changelog
---
### 6.3 - 2024-03-15
* Bluesky:
* Normalize handles to lower case, remove leading `@` ([bridgy#1667](https://github.com/snarfed/bridgy/issues/1667)).
Miscellaneous changes in `webutil`.
### 6.2 - 2023-09-15
Miscellaneous changes in `webutil`.
### 6.1 - 2023-03-22
_Non-breaking changes:_
* IndieAuth:
* Store access token and refresh token in `IndieAuth` datastore entities.
* Flickr:
* Handle errors from initial OAuth 1.0 authorization request.
### 6.0 - 2022-12-03
_Breaking changes:_
* Remove `webutil.handlers`, which was based on the largely unmaintained [`webapp2`](https://github.com/GoogleCloudPlatform/webapp2). All known clients have migrated to [Flask](https://palletsprojects.com/p/flask/) and `webutil.flask_util`.
* Drop Python 3.6 support. Python 3.7 is now the minimum required version.
_Non-breaking changes:_
* Add new `twitter_v2` module for Twitter's new [OAuth 2 with PKCE](https://developer.twitter.com/en/docs/authentication/oauth-2-0/authorization-code) support and [v2 API](https://developer.twitter.com/en/docs/twitter-api/migrate/whats-new).
* IndieAuth:
* Add support for [authorization endpoints](https://indieauth.spec.indieweb.org/#authorization-endpoint), along with existing [token endpoint](https://indieauth.spec.indieweb.org/#token-endpoint) support. Thanks [@jamietanna](https://www.jvt.me/)! ([#284](https://github.com/snarfed/oauth-dropins/pull/284))
* Blogger:
* Fix bug when user approves the OAuth prompt but has no Blogger blogs. Instead of crashing, we now redirect to the callback with `declined=True`, which is still wrong, but less bad.
* Mastodon:
* Change `MastodonAuth.access_token_str` from ndb `TextProperty` to `StringProperty` so that it's indexed in the Datastore.
* When the callback gets an invalid `state` parameter, return HTTP 400 instead of raising `JSONDecodeError`.
* Misc webutil updates.
### 5.0 - 2022-03-23
_Breaking changes:_
* Drop Python 3.5 support. Python 3.6 is now the minimum required version.
_Non-breaking changes:_
* Switch from app_server to `flask run` for local development.
* Add `webutil.util.set_user_agent` to set `User-Agent` header to be sent with all HTTP requests.
### 4.0 - 2021-09-15
_Breaking changes:_
* Migrate from [webapp2](https://github.com/GoogleCloudPlatform/webapp2/) to [Flask](https://flask.palletsprojects.com/). webapp2 had a good run, but it's no longer actively developed, and Flask is one of the most widely adopted standalone web frameworks in the Python community.
* Remove `to()` class methods. Instead, now pass redirect paths to Flask's `as_view()` function, eg:
```py
app = Flask()
app.add_url_rule('/start', view_func=twitter.Callback.as_view('start', '/oauth_callback'))
```
* Remove deprecated `blogger_v2` module alias.
* `webutil`: migrate webapp2 HTTP request handlers in the `handlers` module - `XrdOrJrdHandler`, `HostMetaHandler`, and `HostMetaXrdsHandler` - to Flask views in a new `flask_util` module.
_Non-breaking changes:_
* `webutil`: implement [Webmention](https://webmention.net/) protocol in new `webmention` module.
* `webutil`: add misc Flask utilities and helpers in new `flask_util` module.
### 3.1 - 2021-04-03
* Add Python 3.8 support, drop 3.3 and 3.4. Python 3.5 is now the minimum required version.
* Add [Pixelfed](https://pixelfed.org/) support, heavily based on Mastodon.
* Add [Reddit](https://pixelfed.org/) support. Thanks [Will Stedden](https://bonkerfield.org/)!
* WordPress.com:
* Handle errors from access token request.
### 3.0 - 2020-03-14
_Breaking changes:_
* _Python 2 is no longer supported!_ Including the [App Engine Standard Python 2 runtime](https://cloud.google.com/appengine/docs/standard/python/). On the plus side, the [Python 3 runtimes](https://cloud.google.com/appengine/docs/standard/python3/), both [Standard](https://cloud.google.com/appengine/docs/standard/python3/) and [Flexible](https://cloud.google.com/appengine/docs/flexible/python/), are now supported.
* Replace `handlers.memcache_response()`, which used Python 2 App Engine's memcache service, with `cache_response()`, which uses local runtime memory.
* Remove the `handlers.TemplateHandler.USE_APPENGINE_WEBAPP` toggle to use Python 2 App Engine's `google.appengine.ext.webapp2.template` instead of Jinja.
* Blogger:
* Login is now based on [Google Sign-In](https://developers.google.com/identity/). The `api_from_creds()`, `creds()`, and `http()` methods have been removed. Use the remaining `api()` method to get a `BloggerClient`, or `access_token()` to make API calls manually.
* Google:
* Replace `GoogleAuth` with the new `GoogleUser` NDB model class, which [doesn't depend on the deprecated oauth2client](https://google-auth.readthedocs.io/en/latest/oauth2client-deprecation.html).
* Drop `http()` method (which returned an `httplib2.Http`).
* Mastodon:
* `StartHandler`: drop `APP_NAME`/`APP_URL` class attributes and `app_name`/`app_url` kwargs in the `to()` method and replace them with new `app_name()`/`app_url()` methods that subclasses should override, since they often depend on WSGI environment variables like `HTTP_HOST` and `SERVER_NAME` that are available during requests but not at runtime startup.
* `webutil`:
* Drop `handlers.memcache_response()` since the Python 3 runtime doesn't include memcache.
* Drop `handlers.TemplateHandler` support for `webapp2.template` via `USE_APPENGINE_WEBAPP`, since the Python 3 runtime doesn't include `webapp2` built in.
* Remove `cache` and `fail_cache_time_secs` kwargs from `util.follow_redirects()`. Caching is now built in. You can bypass the cache with `follow_redirects.__wrapped__()`. [Details.](https://cachetools.readthedocs.io/en/stable/#cachetools.cached)
Non-breaking changes:
* Add Meetup support. (Thanks [Jamie Tanna](https://www.jvt.me/)!)
* Blogger, Google:
* The `state` query parameter now works!
* Add new `outer_classes` kwarg to `button_html()` for the outer `<div>`, eg as Bootstrap columns.
* Add new `image_file` kwarg to `StartHandler.button_html()`
### 2.2 - 2019-11-01
* Add LinkedIn and Mastodon!
* Add Python 3.7 support, and improve overall Python 3 compatibility.
* Add new `button_html()` method to all `StartHandler` classes. Generates the same button HTML and styling as on [oauth-dropins.appspot.com](https://oauth-dropins.appspot.com/).
* Blogger: rename module from `blogger_v2` to `blogger`. The `blogger_v2` module name is still available as an alias, implemented via symlink, but is now deprecated.
* Dropbox: fix crash with unicode header value.
* Google: fix crash when user object doesn't have `name` field.
* Facebook: [upgrade Graph API version from 2.10 to 4.0.](https://developers.facebook.com/docs/graph-api/changelog)
* Update a number of dependencies.
* Switch from Python's built in `json` module to [`ujson`](https://github.com/esnme/ultrajson/) (built into App Engine) to speed up JSON parsing and encoding.
### 2.0 - 2019-02-25
* _Breaking change_: switch from [Google+ Sign-In](https://developers.google.com/+/web/signin/) ([which shuts down in March](https://developers.google.com/+/api-shutdown)) to [Google Sign-In](https://developers.google.com/identity/). Notably, this removes the `googleplus` module and adds a new `google_signin` module, renames the `GooglePlusAuth` class to `GoogleAuth`, and removes its `api()` method. Otherwise, the implementation is mostly the same.
* webutil.logs: return HTTP 400 if `start_time` is before 2008-04-01 (App Engine's rough launch window).
### 1.14 - 2018-11-12
* Fix dev_appserver in Cloud SDK 219 / `app-engine-python` 1.9.76 and onward. [Background.](https://issuetracker.google.com/issues/117145272#comment25)
* Upgrade `google-api-python-client` from 1.6.3 to 1.7.4 to [stop using the global HTTP Batch endpoint](https://developers.googleblog.com/2018/03/discontinuing-support-for-json-rpc-and.html).
* Other minor internal updates.
### 1.13 - 2018-08-08
* IndieAuth: support JSON code verification responses as well as form-encoded ([snarfed/bridgy#809](https://github.com/snarfed/bridgy/issues/809)).
### 1.12 - 2018-03-24
* More Python 3 updates and bug fixes in webutil.util.
### 1.11 - 2018-03-08
* Add GitHub!
* Facebook:
* Pass `state` to the initial OAuth endpoint directly, instead of encoding it into the redirect URL, so the redirect can [match the Strict Mode whitelist](https://developers.facebook.com/blog/post/2017/12/18/strict-uri-matching/).
* Add Python 3 support to webutil.util!
* Add humanize dependency for webutil.logs.
### 1.10 - 2017-12-10
Mostly just internal changes to webutil to support granary v1.10.
### 1.9 - 2017-10-24
Mostly just internal changes to webutil to support granary v1.9.
* Flickr:
* Handle punctuation in error messages.
### 1.8 - 2017-08-29
* Facebook:
* Upgrade Graph API from v2.6 to v2.10.
* Flickr:
* Fix broken `FlickrAuth.urlopen()` method.
* Medium:
* Bug fix for Medium OAuth callback error handling.
* IndieAuth:
* Store authorization endpoint in state instead of rediscovering it from `me` parameter, [which is going away](https://github.com/aaronpk/IndieAuth.com/issues/167).
### 1.7 - 2017-02-27
* Updates to bundled webutil library, notably WideUnicode class.
### 1.6 - 2016-11-21
* Add auto-generated docs with Sphinx. Published at [oauth-dropins.readthedocs.io](http://oauth-dropins.readthedocs.io/).
* Fix Dropbox bug with fetching access token.
### 1.5 - 2016-08-25
* Add [Medium](https://medium.com/).
### 1.4 - 2016-06-27
* Upgrade Facebook API from v2.2 to v2.6.
### 1.3 - 2016-04-07
* Add [IndieAuth](https://indieauth.com/).
* More consistent logging of HTTP requests.
* Set up Coveralls.
### 1.2 - 2016-01-11
* Flickr:
* Add upload method.
* Improve error handling and logging.
* Bug fixes and cleanup for constructing scope strings.
* Add developer setup and troubleshooting docs.
* Set up CircleCI.
### 1.1 - 2015-09-06
* Flickr: split out flickr_auth.py file.
* Add a number of utility functions to webutil.
### 1.0 - 2015-06-27
* Initial PyPi release.
Development
---
Pull requests are welcome! Feel free to [ping me in #indieweb-dev](https://indieweb.org/discuss) with any questions.
First, fork and clone this repo. Then, install the [Google Cloud SDK](https://cloud.google.com/sdk/) and run `gcloud components install beta cloud-datastore-emulator` to install the [datastore emulator](https://cloud.google.com/datastore/docs/tools/datastore-emulator). Then, set up your environment by running these commands in the repo root directory. Once you have them, set up your environment by running these commands in the repo root directory:
```shell
gcloud config set project oauth-dropins
git submodule init
git submodule update
python3 -m venv local
source local/bin/activate
pip install -r requirements.txt
```
Run the demo app locally with [`flask run`](https://flask.palletsprojects.com/en/2.0.x/cli/#run-the-development-server):
```shell
gcloud beta emulators datastore start --use-firestore-in-datastore-mode --no-store-on-disk --host-port=localhost:8089 --quiet < /dev/null >& /dev/null &
GAE_ENV=localdev FLASK_ENV=development flask run -p 8080
```
To deploy to production:
`gcloud -q beta app deploy --no-cache oauth-dropins *.yaml`
The docs are built with [Sphinx](http://sphinx-doc.org/), including [apidoc](http://www.sphinx-doc.org/en/stable/man/sphinx-apidoc.html), [autodoc](http://www.sphinx-doc.org/en/stable/ext/autodoc.html), and [napoleon](http://www.sphinx-doc.org/en/stable/ext/napoleon.html). Configuration is in [`docs/conf.py`](https://github.com/snarfed/oauth-dropins/blob/master/docs/conf.py) To build them, first install Sphinx with `pip install sphinx`. (You may want to do this outside your virtualenv; if so, you'll need to reconfigure it to see system packages with `python3 -m venv --system-site-packages local`.) Then, run [`docs/build.sh`](https://github.com/snarfed/oauth-dropins/blob/master/docs/build.sh).
Release instructions
---
Here's how to package, test, and ship a new release. (Note that this is [largely duplicated in granary's readme too](https://github.com/snarfed/granary#release-instructions).)
1. Run the unit tests.
```sh
source local/bin/activate.csh
gcloud beta emulators datastore start --use-firestore-in-datastore-mode --no-store-on-disk --host-port=localhost:8089 < /dev/null >& /dev/null &
sleep 2s
DATASTORE_EMULATOR_HOST=localhost:8081 DATASTORE_DATASET=oauth-dropins \
python3 -m unittest discover
kill %1
deactivate
```
1. Bump the version number in `setup.py` and `docs/conf.py`. `git grep` the old version number to make sure it only appears in the changelog. Change the current changelog entry in `README.md` for this new version from _unreleased_ to the current date.
1. Build the docs. If you added any new modules, add them to the appropriate file(s) in `docs/source/`. Then run `./docs/build.sh`.
1. `git commit -am 'release vX.Y'`
1. Upload to [test.pypi.org](https://test.pypi.org/) for testing.
```sh
python3 setup.py clean build sdist
setenv ver X.Y
source local/bin/activate.csh
twine upload -r pypitest dist/oauth-dropins-$ver.tar.gz
```
1. Install from test.pypi.org.
```sh
cd /tmp
python3 -m venv local
source local/bin/activate.csh
pip3 install --upgrade pip
# mf2py 1.1.2 on test.pypi.org is broken :(
pip3 install mf2py
pip3 install -i https://test.pypi.org/simple --extra-index-url https://pypi.org/simple oauth-dropins
deactivate
```
1. Smoke test that the code trivially loads and runs.
```sh
source local/bin/activate.csh
python3
# run test code below
deactivate
```
Test code to paste into the interpreter:
```py
from oauth_dropins.webutil import util
util.__file__
util.UrlCanonicalizer()('http://asdf.com')
# should print 'https://asdf.com/'
exit()
```
1. Tag the release in git. In the tag message editor, delete the generated comments at bottom, leave the first line blank (to omit the release "title" in github), put `### Notable changes` on the second line, then copy and paste this version's changelog contents below it.
```sh
git tag -a v$ver --cleanup=verbatim
git push
git push --tags
```
1. [Click here to draft a new release on GitHub.](https://github.com/snarfed/oauth-dropins/releases/new) Enter `vX.Y` in the _Tag version_ box. Leave _Release title_ empty. Copy `### Notable changes` and the changelog contents into the description text box.
1. Upload to [pypi.org](https://pypi.org/)!
```sh
twine upload dist/oauth-dropins-$ver.tar.gz
```
Related work
---
* [Loginpass](https://github.com/authlib/loginpass)/[Authlib](https://authlib.org/)
* [Authomatic](https://authomatic.github.io/authomatic/)
* [Python Social Auth](https://python-social-auth.readthedocs.io/en/latest/)
* [Authl](https://authl.readthedocs.io/en/stable/)
Raw data
{
"_id": null,
"home_page": "https://github.com/snarfed/oauth-dropins",
"name": "oauth-dropins",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "oauth appengine",
"author": "Ryan Barrett",
"author_email": "oauth-dropins@ryanb.org",
"download_url": "https://files.pythonhosted.org/packages/71/55/5df9bc9a327687d12faba92f0c9b593134be1f0939e6c3a737eb2ba21547/oauth-dropins-6.3.tar.gz",
"platform": null,
"description": "<img src=\"https://raw.github.com/snarfed/oauth-dropins/main/oauth_dropins/static/oauth_shiny.png\" alt=\"OAuth logo\" width=\"125\" /> oauth-dropins [](https://circleci.com/gh/snarfed/oauth-dropins)\n=============\n\nDrop-in Python [OAuth](http://oauth.net/) for popular sites!\n\n* [About](#about)\n* [Quick start](#quick-start)\n* [Usage details](#usage-details)\n* [Troubleshooting/FAQ](#troubleshootingfaq)\n* [Changelog](#changelog)\n* [Development](#development)\n* [Release instructions](#release-instructions)\n\n\nAbout\n---\n\nThis is a collection of drop-in Python [Flask](https://flask.palletsprojects.com/) views for the initial [OAuth](http://oauth.net/) client flows for many popular sites, including Blogger, Disqus, Dropbox, Facebook, Flickr, GitHub, Google, IndieAuth, Instagram, LinkedIn, Mastodon, Medium, Tumblr, Twitter, and WordPress.com.\n\noauth-dropins stores user credentials in [Google Cloud Datastore](https://cloud.google.com/datastore/). It's primarily designed for [Google App Engine](https://appengine.google.com/), but it can be used in any Python web application, regardless of host or framework.\n\n* [Available on PyPi.](https://pypi.python.org/pypi/oauth-dropins/) Install with `pip install oauth-dropins`.\n* [Getting started docs.](#quick-start)\n* [Reference docs.](https://oauth-dropins.readthedocs.io/en/latest/source/oauth_dropins.html)\n* Demo app at [oauth-dropins.appspot.com](http://oauth-dropins.appspot.com/).\n* [Source code on GitHub.](https://github.com/snarfed/oauth-dropins/)\n\nThis software is released into the public domain. See LICENSE for details.\n\n\nQuick start\n---\n\nHere's a full example of using the GitHub drop-in.\n\n1. Install oauth-dropins with `pip install oauth-dropins`.\n1. Put your [GitHub OAuth application's](https://docs.github.com/en/developers/apps/building-oauth-apps/creating-an-oauth-app) ID and secret in two plain text files in your app's root directory, `github_client_id` and `github_client_secret`. (If you use git, you'll probably also want to add them to your `.gitignore`.)\n1. Create a `github_oauth.py` file with these contents:\n\n ```python\n from oauth_dropins import github\n from app import app # ...or wherever your Flask app is\n \n app.add_url_rule('/start',\n view_func=github.Start.as_view('start', '/callback'),\n methods=['POST'])\n app.add_url_rule('/callback',\n view_func=github.Callback.as_view('callback', '/after'))\n ```\n\nVoila! Send your users to `/github/start` when you want them to connect their GitHub account to your app, and when they're done, they'll be redirected to `/after?access_token=...` in your app.\n\nAll of the sites provide the same API. To use a different one, just import the site module you want and follow the same steps. The filenames for app keys and secrets also differ by site; see each site's `.py` file for its filenames.\n\n\nUsage details\n---\n\nThere are three main parts to an OAuth drop-in: the initial redirect to the site itself, the redirect back to your app after the user approves or declines the request, and the datastore entity that stores the user's OAuth credentials and helps you use them. These are implemented by [`Start`](#start) and [`Callback`](#callback), which are [Flask](https://flask.palletsprojects.com/) [View](https://flask.palletsprojects.com/en/2.0.x/api/#flask.views.View) classes, and [auth entities](#auth-entities), which are [Google Cloud Datastore](https://cloud.google.com/datastore/) [ndb models](https://googleapis.dev/python/python-ndb/latest/model.html).\n\n\n### `Start`\n\nThis view class redirects you to an OAuth-enabled site so it can ask the user to grant your app permission. It has two useful methods:\n\n- The constructor, `__init__(self, to_path, scopes=None)`. `to_path` is the OAuth callback, ie URL path on your site that the site's OAuth flow should redirect back to after it's done. This is handled by a [`Callback`](#callback) view in your application, which needs to handle the `to_path` route.\n\n If you want to add OAuth scopes beyond the default one(s) needed for login, you can pass them to the `scopes` kwarg as a string or sequence of strings, or include them in the `scopes` query parameter in the POST request body. This is supported in most sites, but not all.\n\n Some OAuth 1 sites support alternatives to scopes. For Twitter, the `Start` constructor takes an additional `access_type` kwarg that may be `read` or `write`. It's passed through to Twitter [`x_auth_access_type`](https://dev.twitter.com/docs/api/1/post/oauth/request_token). For Flickr, `Start` accepts a `perms` POST query parameter that may be `read`, `write` or `delete`; it's [passed through to Flickr](https://www.flickr.com/services/api/auth.oauth.html#authorization) unchanged. (Flickr claims it's optional, but [sometimes breaks if it's not provided.](http://stackoverflow.com/questions/6517317/flickr-api-error-when-oauth))\n\n- `redirect_url(state=None)` returns the URL to redirect to at the site to initiate the OAuth flow. `Start` will redirect here automatically if it's used in a WSGI application, but you can call this manually if you want to control that redirect yourself:\n\n```python\nimport flask\n\nclass MyView(Start):\n def dispatch_request(self):\n ...\n flask.redirect(self.redirect_url())\n```\n\n\n### `Callback`\n\nThis class handles the HTTP redirect back to your app after the user has granted or declined permission. It also has two useful methods:\n\n- The constructor, `__init__(self, to_path, scopes=None)`. `to_path` is the URL path on your site that users should be redirected to after the callback view is done. It will include a `state` query parameter with the value provided to `Start`. It will also include an OAuth token in its query parameters, either `access_token` for OAuth 2.0 or `access_token_key` and `access_token_secret` for OAuth 1.1. It will also include an `auth_entity` query parameter with the string key of an [auth entity](#auth-entities) that has more data (and functionality) for the authenticated user. If the user declined the OAuth authorization request, the only query parameter besides `state` will be `declined=true`.\n\n- `finish(auth_entity, state=None)` is run in the initial callback request after the OAuth response has been processed. `auth_entity` is the newly created auth entity for this connection, or `None` if the user declined the OAuth authorization request.\n\n By default, `finish` redirects to `to_path`, but you can subclass `Callback` and override it to run your own code instead of redirecting:\n\n```python\nclass MyCallback(github.Callback):\n def finish(self, auth_entity, state=None):\n super().finish(auth_entity, state=state) # ignore returned redirect\n self.response.write('Hi %s, thanks for connecting your %s account.' %\n (auth_entity.user_display_name(), auth_entity.site_name()))\n```\n\n\n### Auth entities\n\nEach site defines a Google Cloud Datastore [ndb.Model class](https://developers.google.com/appengine/docs/python/datastore/entities#Python_Kinds_and_identifiers) that stores each user's OAuth credentials and other useful information, like their name and profile URL. The class name is generally of the form <em>Site</em>Auth, e.g. `GitHubAuth`. Here are the useful methods:\n\n- `site_name()` returns the human-readable string name of the site, e.g. \"Facebook\".\n\n- `user_display_name()` returns a human-readable string name for the user, e.g. \"Ryan Barrett\". This is usually their first name, full name, or username.\n\n- `access_token()` returns the OAuth access token. For OAuth 2 sites, this is a single string. For OAuth 1.1 sites (currently just Twitter, Tumblr, and Flickr), this is a `(string key, string secret)` tuple.\n\nThe following methods are optional. Auth entity classes usually implement at least one of them, but not all.\n\n- `api()` returns a site-specific API object. This is usually a third party library dedicated to the site, e.g. [Tweepy](https://github.com/tweepy/tweepy) or [python-instagram](https://github.com/Instagram/python-instagram). See the site class's docstring for details.\n\n- `urlopen(data=None, timeout=None)` wraps `urlopen()` and adds the OAuth credentials to the request. Use this for making direct HTTP request to a site's REST API. Some sites may provide `get()` instead, which wraps `requests.get()`.\n\n\nTroubleshooting/FAQ\n---\n1. If you get this error:\n\n ```\n bash: ./bin/easy_install: ...bad interpreter: No such file or directory\n ```\n\n You've probably hit [this virtualenv bug](https://github.com/pypa/virtualenv/issues/53): virtualenv doesn't support paths with spaces.\n\n The easy fix is to recreate the virtualenv in a path without spaces. If you can't do that, then after creating the virtualenv, but before activating it, edit the activate, easy_install and pip files in `local/bin/` to escape any spaces in the path.\n\n For example, in `activate`, `VIRTUAL_ENV=\".../has space/local\"` becomes `VIRTUAL_ENV=\".../has\\ space/local\"`, and in `pip` and `easy_install` the first line changes from `#!\".../has space/local/bin/python\"` to `#!\".../has\\ space/local/bin/python\"`.\n\n This should get virtualenv to install in the right place. If you do this wrong at first, you'll have installs in eg `/usr/local/lib/python3.7/site-packages` that you need to delete, since they'll prevent virtualenv from installing into the local `site-packages`.\n\n1. If you see errors importing or using `tweepy`, it may be because `six.py` isn't installed. Try `pip install six` manually. `tweepy` does include `six` in its dependencies, so this shouldn't be necessary. Please [let us know](https://github.com/snarfed/oauth-dropins/issues) if it happens to you so we can debug!\n\n1. If you get an error like this:\n\n ```\n Running setup.py develop for gdata\n ...\n error: option --home not recognized\n ...\n InstallationError: Command /usr/bin/python -c \"import setuptools, tokenize; __file__='/home/singpolyma/src/bridgy/src/gdata/setup.py'; exec(compile(getattr(tokenize, 'open', open)(__file__).read().replace('\\r\\n', '\\n'), __file__, 'exec'))\" develop --no-deps --home=/tmp/tmprBISz_ failed with error code 1 in .../src/gdata\n ```\n\n ...you may be hitting [Pip bug 1833](https://github.com/pypa/pip/issues/1833). Are you passing `-t` to `pip install`? Use the virtualenv instead, it's your friend. If you really want `-t`, try removing the `-e` from the lines in `requirements.txt` that have it.\n\n\nChangelog\n---\n\n### 6.3 - 2024-03-15\n\n* Bluesky:\n * Normalize handles to lower case, remove leading `@` ([bridgy#1667](https://github.com/snarfed/bridgy/issues/1667)).\n\nMiscellaneous changes in `webutil`.\n\n### 6.2 - 2023-09-15\n\nMiscellaneous changes in `webutil`.\n\n### 6.1 - 2023-03-22\n\n_Non-breaking changes:_\n\n* IndieAuth:\n * Store access token and refresh token in `IndieAuth` datastore entities.\n* Flickr:\n * Handle errors from initial OAuth 1.0 authorization request.\n\n### 6.0 - 2022-12-03\n\n_Breaking changes:_\n\n* Remove `webutil.handlers`, which was based on the largely unmaintained [`webapp2`](https://github.com/GoogleCloudPlatform/webapp2). All known clients have migrated to [Flask](https://palletsprojects.com/p/flask/) and `webutil.flask_util`.\n* Drop Python 3.6 support. Python 3.7 is now the minimum required version.\n\n_Non-breaking changes:_\n\n* Add new `twitter_v2` module for Twitter's new [OAuth 2 with PKCE](https://developer.twitter.com/en/docs/authentication/oauth-2-0/authorization-code) support and [v2 API](https://developer.twitter.com/en/docs/twitter-api/migrate/whats-new).\n* IndieAuth:\n * Add support for [authorization endpoints](https://indieauth.spec.indieweb.org/#authorization-endpoint), along with existing [token endpoint](https://indieauth.spec.indieweb.org/#token-endpoint) support. Thanks [@jamietanna](https://www.jvt.me/)! ([#284](https://github.com/snarfed/oauth-dropins/pull/284))\n* Blogger:\n * Fix bug when user approves the OAuth prompt but has no Blogger blogs. Instead of crashing, we now redirect to the callback with `declined=True`, which is still wrong, but less bad.\n* Mastodon:\n * Change `MastodonAuth.access_token_str` from ndb `TextProperty` to `StringProperty` so that it's indexed in the Datastore.\n * When the callback gets an invalid `state` parameter, return HTTP 400 instead of raising `JSONDecodeError`.\n* Misc webutil updates.\n\n### 5.0 - 2022-03-23\n\n_Breaking changes:_\n\n* Drop Python 3.5 support. Python 3.6 is now the minimum required version.\n\n_Non-breaking changes:_\n\n* Switch from app_server to `flask run` for local development.\n* Add `webutil.util.set_user_agent` to set `User-Agent` header to be sent with all HTTP requests.\n\n### 4.0 - 2021-09-15\n\n_Breaking changes:_\n\n* Migrate from [webapp2](https://github.com/GoogleCloudPlatform/webapp2/) to [Flask](https://flask.palletsprojects.com/). webapp2 had a good run, but it's no longer actively developed, and Flask is one of the most widely adopted standalone web frameworks in the Python community.\n* Remove `to()` class methods. Instead, now pass redirect paths to Flask's `as_view()` function, eg:\n \n ```py\n app = Flask()\n app.add_url_rule('/start', view_func=twitter.Callback.as_view('start', '/oauth_callback'))\n ```\n* Remove deprecated `blogger_v2` module alias.\n* `webutil`: migrate webapp2 HTTP request handlers in the `handlers` module - `XrdOrJrdHandler`, `HostMetaHandler`, and `HostMetaXrdsHandler` - to Flask views in a new `flask_util` module.\n\n_Non-breaking changes:_\n\n* `webutil`: implement [Webmention](https://webmention.net/) protocol in new `webmention` module.\n* `webutil`: add misc Flask utilities and helpers in new `flask_util` module.\n\n\n### 3.1 - 2021-04-03\n\n* Add Python 3.8 support, drop 3.3 and 3.4. Python 3.5 is now the minimum required version.\n* Add [Pixelfed](https://pixelfed.org/) support, heavily based on Mastodon.\n* Add [Reddit](https://pixelfed.org/) support. Thanks [Will Stedden](https://bonkerfield.org/)!\n* WordPress.com:\n * Handle errors from access token request.\n\n\n### 3.0 - 2020-03-14\n\n_Breaking changes:_\n\n* _Python 2 is no longer supported!_ Including the [App Engine Standard Python 2 runtime](https://cloud.google.com/appengine/docs/standard/python/). On the plus side, the [Python 3 runtimes](https://cloud.google.com/appengine/docs/standard/python3/), both [Standard](https://cloud.google.com/appengine/docs/standard/python3/) and [Flexible](https://cloud.google.com/appengine/docs/flexible/python/), are now supported.\n* Replace `handlers.memcache_response()`, which used Python 2 App Engine's memcache service, with `cache_response()`, which uses local runtime memory.\n* Remove the `handlers.TemplateHandler.USE_APPENGINE_WEBAPP` toggle to use Python 2 App Engine's `google.appengine.ext.webapp2.template` instead of Jinja.\n* Blogger:\n * Login is now based on [Google Sign-In](https://developers.google.com/identity/). The `api_from_creds()`, `creds()`, and `http()` methods have been removed. Use the remaining `api()` method to get a `BloggerClient`, or `access_token()` to make API calls manually.\n* Google:\n * Replace `GoogleAuth` with the new `GoogleUser` NDB model class, which [doesn't depend on the deprecated oauth2client](https://google-auth.readthedocs.io/en/latest/oauth2client-deprecation.html).\n * Drop `http()` method (which returned an `httplib2.Http`).\n* Mastodon:\n * `StartHandler`: drop `APP_NAME`/`APP_URL` class attributes and `app_name`/`app_url` kwargs in the `to()` method and replace them with new `app_name()`/`app_url()` methods that subclasses should override, since they often depend on WSGI environment variables like `HTTP_HOST` and `SERVER_NAME` that are available during requests but not at runtime startup.\n* `webutil`:\n * Drop `handlers.memcache_response()` since the Python 3 runtime doesn't include memcache.\n * Drop `handlers.TemplateHandler` support for `webapp2.template` via `USE_APPENGINE_WEBAPP`, since the Python 3 runtime doesn't include `webapp2` built in.\n * Remove `cache` and `fail_cache_time_secs` kwargs from `util.follow_redirects()`. Caching is now built in. You can bypass the cache with `follow_redirects.__wrapped__()`. [Details.](https://cachetools.readthedocs.io/en/stable/#cachetools.cached)\n\nNon-breaking changes:\n\n* Add Meetup support. (Thanks [Jamie Tanna](https://www.jvt.me/)!)\n* Blogger, Google:\n * The `state` query parameter now works!\n* Add new `outer_classes` kwarg to `button_html()` for the outer `<div>`, eg as Bootstrap columns.\n* Add new `image_file` kwarg to `StartHandler.button_html()`\n\n### 2.2 - 2019-11-01\n* Add LinkedIn and Mastodon!\n* Add Python 3.7 support, and improve overall Python 3 compatibility.\n* Add new `button_html()` method to all `StartHandler` classes. Generates the same button HTML and styling as on [oauth-dropins.appspot.com](https://oauth-dropins.appspot.com/).\n* Blogger: rename module from `blogger_v2` to `blogger`. The `blogger_v2` module name is still available as an alias, implemented via symlink, but is now deprecated.\n* Dropbox: fix crash with unicode header value.\n* Google: fix crash when user object doesn't have `name` field.\n* Facebook: [upgrade Graph API version from 2.10 to 4.0.](https://developers.facebook.com/docs/graph-api/changelog)\n* Update a number of dependencies.\n* Switch from Python's built in `json` module to [`ujson`](https://github.com/esnme/ultrajson/) (built into App Engine) to speed up JSON parsing and encoding.\n\n### 2.0 - 2019-02-25\n* _Breaking change_: switch from [Google+ Sign-In](https://developers.google.com/+/web/signin/) ([which shuts down in March](https://developers.google.com/+/api-shutdown)) to [Google Sign-In](https://developers.google.com/identity/). Notably, this removes the `googleplus` module and adds a new `google_signin` module, renames the `GooglePlusAuth` class to `GoogleAuth`, and removes its `api()` method. Otherwise, the implementation is mostly the same.\n* webutil.logs: return HTTP 400 if `start_time` is before 2008-04-01 (App Engine's rough launch window).\n\n### 1.14 - 2018-11-12\n* Fix dev_appserver in Cloud SDK 219 / `app-engine-python` 1.9.76 and onward. [Background.](https://issuetracker.google.com/issues/117145272#comment25)\n* Upgrade `google-api-python-client` from 1.6.3 to 1.7.4 to [stop using the global HTTP Batch endpoint](https://developers.googleblog.com/2018/03/discontinuing-support-for-json-rpc-and.html).\n* Other minor internal updates.\n\n### 1.13 - 2018-08-08\n* IndieAuth: support JSON code verification responses as well as form-encoded ([snarfed/bridgy#809](https://github.com/snarfed/bridgy/issues/809)).\n\n### 1.12 - 2018-03-24\n* More Python 3 updates and bug fixes in webutil.util.\n\n### 1.11 - 2018-03-08\n* Add GitHub!\n* Facebook:\n * Pass `state` to the initial OAuth endpoint directly, instead of encoding it into the redirect URL, so the redirect can [match the Strict Mode whitelist](https://developers.facebook.com/blog/post/2017/12/18/strict-uri-matching/).\n* Add Python 3 support to webutil.util!\n* Add humanize dependency for webutil.logs.\n\n### 1.10 - 2017-12-10\nMostly just internal changes to webutil to support granary v1.10.\n\n### 1.9 - 2017-10-24\nMostly just internal changes to webutil to support granary v1.9.\n\n* Flickr:\n * Handle punctuation in error messages.\n\n### 1.8 - 2017-08-29\n* Facebook:\n * Upgrade Graph API from v2.6 to v2.10.\n* Flickr:\n * Fix broken `FlickrAuth.urlopen()` method.\n* Medium:\n * Bug fix for Medium OAuth callback error handling.\n* IndieAuth:\n * Store authorization endpoint in state instead of rediscovering it from `me` parameter, [which is going away](https://github.com/aaronpk/IndieAuth.com/issues/167).\n\n### 1.7 - 2017-02-27\n* Updates to bundled webutil library, notably WideUnicode class.\n\n### 1.6 - 2016-11-21\n* Add auto-generated docs with Sphinx. Published at [oauth-dropins.readthedocs.io](http://oauth-dropins.readthedocs.io/).\n* Fix Dropbox bug with fetching access token.\n\n### 1.5 - 2016-08-25\n* Add [Medium](https://medium.com/).\n\n### 1.4 - 2016-06-27\n* Upgrade Facebook API from v2.2 to v2.6.\n\n### 1.3 - 2016-04-07\n* Add [IndieAuth](https://indieauth.com/).\n* More consistent logging of HTTP requests.\n* Set up Coveralls.\n\n### 1.2 - 2016-01-11\n* Flickr:\n * Add upload method.\n * Improve error handling and logging.\n* Bug fixes and cleanup for constructing scope strings.\n* Add developer setup and troubleshooting docs.\n* Set up CircleCI.\n\n### 1.1 - 2015-09-06\n* Flickr: split out flickr_auth.py file.\n* Add a number of utility functions to webutil.\n\n### 1.0 - 2015-06-27\n* Initial PyPi release.\n\n\nDevelopment\n---\nPull requests are welcome! Feel free to [ping me in #indieweb-dev](https://indieweb.org/discuss) with any questions.\n\nFirst, fork and clone this repo. Then, install the [Google Cloud SDK](https://cloud.google.com/sdk/) and run `gcloud components install beta cloud-datastore-emulator` to install the [datastore emulator](https://cloud.google.com/datastore/docs/tools/datastore-emulator). Then, set up your environment by running these commands in the repo root directory. Once you have them, set up your environment by running these commands in the repo root directory:\n\n```shell\ngcloud config set project oauth-dropins\ngit submodule init\ngit submodule update\npython3 -m venv local\nsource local/bin/activate\npip install -r requirements.txt\n```\n\nRun the demo app locally with [`flask run`](https://flask.palletsprojects.com/en/2.0.x/cli/#run-the-development-server):\n\n```shell\ngcloud beta emulators datastore start --use-firestore-in-datastore-mode --no-store-on-disk --host-port=localhost:8089 --quiet < /dev/null >& /dev/null &\nGAE_ENV=localdev FLASK_ENV=development flask run -p 8080\n```\n\nTo deploy to production:\n\n`gcloud -q beta app deploy --no-cache oauth-dropins *.yaml`\n\nThe docs are built with [Sphinx](http://sphinx-doc.org/), including [apidoc](http://www.sphinx-doc.org/en/stable/man/sphinx-apidoc.html), [autodoc](http://www.sphinx-doc.org/en/stable/ext/autodoc.html), and [napoleon](http://www.sphinx-doc.org/en/stable/ext/napoleon.html). Configuration is in [`docs/conf.py`](https://github.com/snarfed/oauth-dropins/blob/master/docs/conf.py) To build them, first install Sphinx with `pip install sphinx`. (You may want to do this outside your virtualenv; if so, you'll need to reconfigure it to see system packages with `python3 -m venv --system-site-packages local`.) Then, run [`docs/build.sh`](https://github.com/snarfed/oauth-dropins/blob/master/docs/build.sh).\n\n\nRelease instructions\n---\nHere's how to package, test, and ship a new release. (Note that this is [largely duplicated in granary's readme too](https://github.com/snarfed/granary#release-instructions).)\n\n1. Run the unit tests.\n ```sh\n source local/bin/activate.csh\n gcloud beta emulators datastore start --use-firestore-in-datastore-mode --no-store-on-disk --host-port=localhost:8089 < /dev/null >& /dev/null &\n sleep 2s\n DATASTORE_EMULATOR_HOST=localhost:8081 DATASTORE_DATASET=oauth-dropins \\\n python3 -m unittest discover\n kill %1\n deactivate\n ```\n1. Bump the version number in `setup.py` and `docs/conf.py`. `git grep` the old version number to make sure it only appears in the changelog. Change the current changelog entry in `README.md` for this new version from _unreleased_ to the current date.\n1. Build the docs. If you added any new modules, add them to the appropriate file(s) in `docs/source/`. Then run `./docs/build.sh`.\n1. `git commit -am 'release vX.Y'`\n1. Upload to [test.pypi.org](https://test.pypi.org/) for testing.\n ```sh\n python3 setup.py clean build sdist\n setenv ver X.Y\n source local/bin/activate.csh\n twine upload -r pypitest dist/oauth-dropins-$ver.tar.gz\n ```\n1. Install from test.pypi.org.\n ```sh\n cd /tmp\n python3 -m venv local\n source local/bin/activate.csh\n pip3 install --upgrade pip\n # mf2py 1.1.2 on test.pypi.org is broken :(\n pip3 install mf2py\n pip3 install -i https://test.pypi.org/simple --extra-index-url https://pypi.org/simple oauth-dropins\n deactivate\n ```\n1. Smoke test that the code trivially loads and runs.\n ```sh\n source local/bin/activate.csh\n python3\n # run test code below\n deactivate\n ```\n Test code to paste into the interpreter:\n ```py\n from oauth_dropins.webutil import util\n util.__file__\n util.UrlCanonicalizer()('http://asdf.com')\n # should print 'https://asdf.com/'\n exit()\n ```\n1. Tag the release in git. In the tag message editor, delete the generated comments at bottom, leave the first line blank (to omit the release \"title\" in github), put `### Notable changes` on the second line, then copy and paste this version's changelog contents below it.\n ```sh\n git tag -a v$ver --cleanup=verbatim\n git push\n git push --tags\n ```\n1. [Click here to draft a new release on GitHub.](https://github.com/snarfed/oauth-dropins/releases/new) Enter `vX.Y` in the _Tag version_ box. Leave _Release title_ empty. Copy `### Notable changes` and the changelog contents into the description text box.\n1. Upload to [pypi.org](https://pypi.org/)!\n ```sh\n twine upload dist/oauth-dropins-$ver.tar.gz\n ```\n\n\nRelated work\n---\n* [Loginpass](https://github.com/authlib/loginpass)/[Authlib](https://authlib.org/)\n* [Authomatic](https://authomatic.github.io/authomatic/)\n* [Python Social Auth](https://python-social-auth.readthedocs.io/en/latest/)\n* [Authl](https://authl.readthedocs.io/en/stable/)\n",
"bugtrack_url": null,
"license": "Public domain",
"summary": "Drop-in OAuth Flask views for many popular sites.",
"version": "6.3",
"project_urls": {
"Homepage": "https://github.com/snarfed/oauth-dropins"
},
"split_keywords": [
"oauth",
"appengine"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "71555df9bc9a327687d12faba92f0c9b593134be1f0939e6c3a737eb2ba21547",
"md5": "08de8f2f7d4d9f2aa0d4415d77b85737",
"sha256": "a2148ec1a4fa02c308c79218a308e4720324ab422f4cba5043bbc956c71785d5"
},
"downloads": -1,
"filename": "oauth-dropins-6.3.tar.gz",
"has_sig": false,
"md5_digest": "08de8f2f7d4d9f2aa0d4415d77b85737",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 1382409,
"upload_time": "2024-03-16T04:40:08",
"upload_time_iso_8601": "2024-03-16T04:40:08.855102Z",
"url": "https://files.pythonhosted.org/packages/71/55/5df9bc9a327687d12faba92f0c9b593134be1f0939e6c3a737eb2ba21547/oauth-dropins-6.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-16 04:40:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "snarfed",
"github_project": "oauth-dropins",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"circle": true,
"requirements": [
{
"name": "gdata",
"specs": []
},
{
"name": "lexrpc",
"specs": []
},
{
"name": "mox3",
"specs": []
},
{
"name": "fixtures",
"specs": [
[
"==",
"4.1.0"
]
]
},
{
"name": "pbr",
"specs": [
[
"==",
"6.0.0"
]
]
},
{
"name": "attrs",
"specs": [
[
"==",
"23.2.0"
]
]
},
{
"name": "bases",
"specs": [
[
"==",
"0.3.0"
]
]
},
{
"name": "beautifulsoup4",
"specs": [
[
"==",
"4.12.3"
]
]
},
{
"name": "cachetools",
"specs": [
[
"==",
"5.3.3"
]
]
},
{
"name": "certifi",
"specs": [
[
"==",
"2024.2.2"
]
]
},
{
"name": "charset-normalizer",
"specs": [
[
"==",
"3.3.2"
]
]
},
{
"name": "click",
"specs": [
[
"==",
"8.1.7"
]
]
},
{
"name": "colorama",
"specs": [
[
"==",
"0.4.6"
]
]
},
{
"name": "dag-cbor",
"specs": [
[
"==",
"0.3.3"
]
]
},
{
"name": "domain2idna",
"specs": [
[
"==",
"1.12.0"
]
]
},
{
"name": "ecdsa",
"specs": [
[
"==",
"0.19.0"
]
]
},
{
"name": "Flask",
"specs": [
[
"==",
"3.0.3"
]
]
},
{
"name": "Flask-Caching",
"specs": [
[
"==",
"2.1.0"
]
]
},
{
"name": "flask-gae-static",
"specs": [
[
"==",
"1.0"
]
]
},
{
"name": "google-api-core",
"specs": [
[
"==",
"2.11.1"
]
]
},
{
"name": "google-auth",
"specs": [
[
"==",
"2.15.0"
]
]
},
{
"name": "google-cloud-appengine-logging",
"specs": [
[
"==",
"1.4.3"
]
]
},
{
"name": "google-cloud-audit-log",
"specs": [
[
"==",
"0.2.5"
]
]
},
{
"name": "google-cloud-core",
"specs": [
[
"==",
"2.3.2"
]
]
},
{
"name": "google-cloud-datastore",
"specs": [
[
"==",
"2.16.1"
]
]
},
{
"name": "google-cloud-logging",
"specs": [
[
"==",
"3.10.0"
]
]
},
{
"name": "google-cloud-ndb",
"specs": [
[
"==",
"2.3.1"
]
]
},
{
"name": "googleapis-common-protos",
"specs": [
[
"==",
"1.63.0"
]
]
},
{
"name": "grpc-google-iam-v1",
"specs": [
[
"==",
"0.13.0"
]
]
},
{
"name": "grpcio",
"specs": [
[
"==",
"1.62.2"
]
]
},
{
"name": "grpcio-status",
"specs": [
[
"==",
"1.62.2"
]
]
},
{
"name": "gunicorn",
"specs": [
[
"==",
"22.0.0"
]
]
},
{
"name": "h11",
"specs": [
[
"==",
"0.14.0"
]
]
},
{
"name": "html5lib",
"specs": [
[
"==",
"1.1"
]
]
},
{
"name": "humanize",
"specs": [
[
"==",
"4.9.0"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.7"
]
]
},
{
"name": "idna",
"specs": [
[
"==",
"3.7"
]
]
},
{
"name": "itsdangerous",
"specs": [
[
"==",
"2.2.0"
]
]
},
{
"name": "Jinja2",
"specs": [
[
"==",
"3.1.3"
]
]
},
{
"name": "jsonschema",
"specs": [
[
"==",
"4.21.1"
]
]
},
{
"name": "lxml",
"specs": [
[
"==",
"5.2.1"
]
]
},
{
"name": "MarkupSafe",
"specs": [
[
"==",
"2.1.5"
]
]
},
{
"name": "mf2py",
"specs": [
[
"==",
"2.0.1"
]
]
},
{
"name": "mf2util",
"specs": [
[
"==",
"0.5.2"
]
]
},
{
"name": "multiformats-config",
"specs": [
[
"==",
"0.3.1"
]
]
},
{
"name": "multiformats",
"specs": [
[
"==",
"0.3.1.post4"
]
]
},
{
"name": "oauthlib",
"specs": [
[
"==",
"3.2.2"
]
]
},
{
"name": "packaging",
"specs": [
[
"==",
"24.0"
]
]
},
{
"name": "pkce",
"specs": [
[
"==",
"1.0.3"
]
]
},
{
"name": "praw",
"specs": [
[
"==",
"7.7.1"
]
]
},
{
"name": "prawcore",
"specs": [
[
"==",
"2.4.0"
]
]
},
{
"name": "proto-plus",
"specs": [
[
"==",
"1.23.0"
]
]
},
{
"name": "protobuf",
"specs": [
[
"==",
"4.24.3"
]
]
},
{
"name": "pyasn1",
"specs": [
[
"==",
"0.6.0"
]
]
},
{
"name": "pyasn1-modules",
"specs": [
[
"==",
"0.4.0"
]
]
},
{
"name": "pymemcache",
"specs": [
[
"==",
"4.0.0"
]
]
},
{
"name": "pyparsing",
"specs": [
[
"==",
"3.1.2"
]
]
},
{
"name": "pyrsistent",
"specs": [
[
"==",
"0.20.0"
]
]
},
{
"name": "python-tumblpy",
"specs": [
[
"==",
"1.1.4"
]
]
},
{
"name": "pytz",
"specs": [
[
"==",
"2024.1"
]
]
},
{
"name": "PyYAML",
"specs": [
[
"==",
"6.0.1"
]
]
},
{
"name": "redis",
"specs": [
[
"==",
"5.0.4"
]
]
},
{
"name": "requests",
"specs": [
[
"==",
"2.31.0"
]
]
},
{
"name": "requests-oauthlib",
"specs": [
[
"==",
"1.4.0"
]
]
},
{
"name": "rsa",
"specs": [
[
"==",
"4.9"
]
]
},
{
"name": "simple-websocket",
"specs": [
[
"==",
"1.0.0"
]
]
},
{
"name": "six",
"specs": [
[
"==",
"1.16.0"
]
]
},
{
"name": "soupsieve",
"specs": [
[
"==",
"2.5"
]
]
},
{
"name": "tlslite-ng",
"specs": [
[
"==",
"0.7.6"
]
]
},
{
"name": "tweepy",
"specs": [
[
"==",
"4.14.0"
]
]
},
{
"name": "typing-extensions",
"specs": [
[
"==",
"4.9.0"
]
]
},
{
"name": "typing-validation",
"specs": [
[
"==",
"1.2.11.post1"
]
]
},
{
"name": "ujson",
"specs": [
[
"==",
"5.4.0"
]
]
},
{
"name": "update-checker",
"specs": [
[
"==",
"0.18.0"
]
]
},
{
"name": "urllib3",
"specs": [
[
"==",
"2.2.1"
]
]
},
{
"name": "webencodings",
"specs": [
[
"==",
"0.5.1"
]
]
},
{
"name": "WebOb",
"specs": [
[
"==",
"1.8.7"
]
]
},
{
"name": "websockets",
"specs": [
[
"==",
"12.0"
]
]
},
{
"name": "websocket-client",
"specs": [
[
"==",
"1.8.0"
]
]
}
],
"lcname": "oauth-dropins"
}
