-
-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
582 changed files
with
153 additions
and
33,605 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
# How to contribute | ||
|
||
I like to encourage you to contribute to the repository. | ||
|
||
This should be as easy as possible for you but there are a few things | ||
to consider when contributing. The following guidelines for | ||
contribution should be followed if you want to submit a pull request. | ||
|
||
## How to prepare | ||
|
||
* You need a [GitHub account](https://github.com/signup/free) | ||
* Submit an [issue ticket](https://github.com/python-social-auth/social-app-flask/issues) | ||
for your issue if there is no one yet. | ||
* Describe the issue and include steps to reproduce if it's a bug. | ||
* Ensure to mention the earliest version that you know is affected. | ||
* If you are able and want to fix this, fork the repository on GitHub | ||
|
||
## Make Changes | ||
|
||
* In your forked repository, create a topic branch for your upcoming | ||
patch. (e.g. `feature/new-backend` or `bug/auth-fails`) | ||
* Usually this is based on the `master` branch. | ||
* Create a branch based on master `git branch bug/auth-fails master` | ||
then checkout the new branch with `git checkout bug/auth-fails`. | ||
Please avoid working directly on the `master` branch. | ||
* Make commits of logical units and describe them properly. | ||
* Make sure you stick to [PEP8](https://www.python.org/dev/peps/pep-0008/) | ||
coding style that is used already. | ||
* If possible, submit tests to your patch / new feature so it can be tested easily. | ||
* Assure nothing is broken by running all the tests. | ||
|
||
## Submit Changes | ||
|
||
* Push your changes to a topic branch in your fork of the repository. | ||
* Open a pull request to the original repository and choose the right | ||
original branch you want to patch. | ||
* If not done in commit messages (which you really should do) please | ||
reference and update your issue with the code changes. But _please | ||
do not close the issue yourself_. | ||
* Even if you have write access to the repository, do not directly | ||
push or merge pull-requests. Let another team member review your | ||
pull request and approve. | ||
|
||
# Additional Resources | ||
|
||
* [General GitHub documentation](http://help.github.com/) | ||
* [GitHub pull request documentation](http://help.github.com/send-pull-requests/) | ||
* [Read the Issue Guidelines by @necolas](https://github.com/necolas/issue-guidelines/blob/master/CONTRIBUTING.md) | ||
for more details | ||
|
||
# Notes | ||
|
||
This documented is based in the work from [anselmh/CONTRIBUTING.md](https://github.com/anselmh/CONTRIBUTING.md), | ||
licensed as [Creative Commons Attribution 3.0 Unported License](https://github.com/anselmh/CONTRIBUTING.md/blob/master/README.md#license). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,3 @@ | ||
global-include *.py | ||
|
||
include *.txt CHANGELOG.md LICENSE README.rst | ||
recursive-include docs *.rst | ||
recursive-include social/tests *.txt | ||
|
||
graft examples | ||
|
||
recursive-exclude .tox * | ||
recursive-exclude social *.pyc | ||
recursive-exclude examples *.pyc | ||
recursive-exclude examples *.db | ||
recursive-exclude examples local_settings.py | ||
recursive-exclude examples/webpy_example/sessions * | ||
include *.txt CHANGELOG.md LICENSE README.md | ||
recursive-exclude social_flask *.pyc |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,22 +1,14 @@ | ||
docs: | ||
sphinx-build docs/ docs/_build/ | ||
|
||
site: docs | ||
rsync -avkz site/ tarf:sites/psa/ | ||
|
||
build: | ||
python setup.py sdist | ||
python setup.py bdist_wheel --python-tag py2 | ||
BUILD_VERSION=3 python setup.py bdist_wheel --python-tag py3 | ||
@ python setup.py sdist | ||
@ python setup.py bdist_wheel --python-tag py2 | ||
@ BUILD_VERSION=3 python setup.py bdist_wheel --python-tag py3 | ||
|
||
publish: | ||
python setup.py sdist upload | ||
python setup.py bdist_wheel --python-tag py2 upload | ||
BUILD_VERSION=3 python setup.py bdist_wheel --python-tag py3 upload | ||
@ python setup.py sdist upload | ||
@ python setup.py bdist_wheel --python-tag py2 upload | ||
@ BUILD_VERSION=3 python setup.py bdist_wheel --python-tag py3 upload | ||
|
||
clean: | ||
find . -name '*.py[co]' -delete | ||
find . -name '__pycache__' -delete | ||
rm -rf python_social_auth.egg-info dist build | ||
|
||
.PHONY: site docs publish | ||
@ find . -name '*.py[co]' -delete | ||
@ find . -name '__pycache__' -delete | ||
@ rm -rf *.egg-info dist build |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
# Python Social Auth - Flask | ||
|
||
Python Social Auth is an easy to setup social authentication/registration | ||
mechanism with support for several frameworks and auth providers. | ||
|
||
## Description | ||
|
||
This is the [Flask](http://flask.pocoo.org/) component of the | ||
[python-social-auth ecosystem](https://github.com/python-social-auth/social-core), | ||
it implements the needed functionality to integrate | ||
[python-social-auth-core](https://github.com/python-social-auth/social-core) | ||
in a Flask based project using. | ||
|
||
## Documentation | ||
|
||
Project documentation is available at http://python-social-auth.readthedocs.org/. | ||
|
||
## Setup | ||
|
||
```shell | ||
$ pip install python-social-auth-app-flask | ||
``` | ||
|
||
## Contributing | ||
|
||
See the [CONTRIBUTING.md](CONTRIBUTING.md) document for details. | ||
|
||
## Versioning | ||
|
||
This project follows [Semantic Versioning 2.0.0](http://semver.org/spec/v2.0.0.html). | ||
|
||
## License | ||
|
||
This project follows the BSD license. See the [LICENSE](LICENSE) for details. |
Oops, something went wrong.