Cleanup pyton-social-auth

.travis.yml

@@ -3,22 +3,22 @@ sudo: false
 env:
   global:
     - REQUIREMENTS=requirements.txt
-    - TEST_REQUIREMENTS=social/tests/requirements.txt
+    - TEST_REQUIREMENTS=social_core/tests/requirements.txt
 python:
   - "2.7"
 matrix:
   include:
     - python: "pypy"
       env:
-        - TEST_REQUIREMENTS=social/tests/requirements-pypy.txt
+        - TEST_REQUIREMENTS=social_core/tests/requirements-pypy.txt
     - python: "3.3"
       env:
         - REQUIREMENTS=requirements-python3.txt
-        - TEST_REQUIREMENTS=social/tests/requirements-python3.txt
+        - TEST_REQUIREMENTS=social_core/tests/requirements-python3.txt
     - python: "3.4"
       env:
         - REQUIREMENTS=requirements-python3.txt
-        - TEST_REQUIREMENTS=social/tests/requirements-python3.txt
+        - TEST_REQUIREMENTS=social_core/tests/requirements-python3.txt
 addons:
   apt:
     packages:
@@ -29,4 +29,4 @@ install:
   - "travis_retry pip install -r $REQUIREMENTS"
   - "travis_retry pip install -r $TEST_REQUIREMENTS"
 script:
-  - "nosetests --with-coverage --cover-package=social --where=social/tests"
+  - "nosetests --with-coverage --cover-package=social_core --where=social_core/tests"

CONTRIBUTING.md

@@ -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-core/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).

LICENSE

@@ -1,20 +1,20 @@
-Copyright (c) 2012-2015, Matías Aguirre
+Copyright (c) 2012-2016, Matías Aguirre
 All rights reserved.
- 
+
 Redistribution and use in source and binary forms, with or without modification,
 are permitted provided that the following conditions are met:
- 
+
     1. Redistributions of source code must retain the above copyright notice,
        this list of conditions and the following disclaimer.
-    
+
     2. Redistributions in binary form must reproduce the above copyright
        notice, this list of conditions and the following disclaimer in the
        documentation and/or other materials provided with the distribution.
- 
+
     3. Neither the name of this project nor the names of its contributors may be
        used to endorse or promote products derived from this software without
        specific prior written permission.
- 
+
 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
 ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE

MANIFEST.in

@@ -1,14 +1,9 @@
 global-include *.py
 
-include *.txt CHANGELOG.md LICENSE README.rst
-recursive-include docs *.rst
-recursive-include social/tests *.txt
+include *.txt CHANGELOG.md LICENSE README.md
+recursive-include social_core/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 *
+recursive-exclude social_core *.pyc

Makefile

@@ -1,22 +1,40 @@
-docs:
-	sphinx-build docs/ docs/_build/
-
-site: docs
-	rsync -avkz site/ tarf:sites/psa/
+PYTHON_VERSIONS := 2.7.12 3.3.6 3.4.4 3.5.2 pypy-4.0.1
 
 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
+check-pyenv:
+	@ which pyenv
+
+# Dependencies: libxml2-dev libxmlsec1-dev libbz2-dev libsqlite3-dev
+#               libreadline-dev zlib1g-dev libncurses5-dev libssl-dev
+#               libgdbm-dev libncursesw5-dev xz-utils swig build-essential
+setup-pyenv-python:
+	@ pyenv install -s $(version)
+	@ pyenv local $(version)
+	@ pip install --upgrade setuptools pip tox
+	@ pyenv local --unset
+
+setup-pyenv: check-pyenv
+	@ eval "$(pyenv init -)"
+	@ $(foreach version, \
+		    $(PYTHON_VERSIONS), \
+		    ${MAKE} setup-pyenv-python version=$(version);)
+	@ pyenv local $(PYTHON_VERSIONS)
 
-.PHONY: site docs publish
+run-tox:
+	@ tox
+
+tests: setup-pyenv run-tox clean
+
+clean:
+	@ find . -name '*.py[co]' -delete
+	@ find . -name '__pycache__' -delete
+	@ rm -rf *.egg-info dist build

README.md

@@ -0,0 +1,33 @@
+# Python Social Auth - Core
+
+Python Social Auth is an easy to setup social authentication/registration
+mechanism with support for several frameworks and auth providers.
+
+## Description
+
+This is the core component of the python-socia-auth ecosystem, it
+implements the common interface to define new authentication backends
+to third parties services, implement integrations with web frameworks
+and storage solutions.
+
+## Documentation
+
+Project documentation is available at http://python-social-auth.readthedocs.org/.
+
+## Setup
+
+```shell
+$ pip install social-auth-core
+```
+
+## 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.