From 9abadd701ce46b9df548a30d58fe13a636b222e5 Mon Sep 17 00:00:00 2001 From: Jonathan Huot Date: Tue, 20 Mar 2018 09:45:29 +0100 Subject: Added emacs ignore list --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.gitignore b/.gitignore index 683f357..6f24649 100644 --- a/.gitignore +++ b/.gitignore @@ -33,6 +33,8 @@ htmlcov* # Local file cruft/auto-backups .DS_Store *~ +**/#*# +**/.#* # Sphinx docs/_build -- cgit v1.2.1 From a03cb7321d583897ac9865d9cb24b632081d16b1 Mon Sep 17 00:00:00 2001 From: Jonathan Huot Date: Tue, 20 Mar 2018 09:44:27 +0100 Subject: Added README.rst/setup.py check for pypi --- tox.ini | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/tox.ini b/tox.ini index 8f3345e..03e25b1 100644 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,5 @@ [tox] -envlist = py27,py34,py35,py36,pypy,docs +envlist = py27,py34,py35,py36,pypy,docs,readme [testenv] deps= @@ -19,3 +19,12 @@ deps=sphinx changedir=docs whitelist_externals=make commands=make clean html + +# tox -e readme to mimick pypi long_description check +[testenv:readme] +skipsdist=True +deps=readme +whitelist_externals=echo +commands= + python setup.py check -r -s + echo setup.py/long description is syntaxly correct -- cgit v1.2.1 From 19ebeae8619c7c784427acf3d37667e403564780 Mon Sep 17 00:00:00 2001 From: Jonathan Huot Date: Tue, 20 Mar 2018 09:43:34 +0100 Subject: Added credits to Idan & team. --- LICENSE | 4 ++-- README.rst | 12 ++++++++++++ docs/conf.py | 2 +- oauthlib/__init__.py | 2 +- setup.py | 2 +- 5 files changed, 17 insertions(+), 5 deletions(-) diff --git a/LICENSE b/LICENSE index c10d256..84b5c75 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -Copyright (c) 2011 Idan Gazit and contributors +Copyright (c) 2018 The OAuthlib Community All rights reserved. Redistribution and use in source and binary forms, with or without @@ -24,4 +24,4 @@ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. \ No newline at end of file +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. diff --git a/README.rst b/README.rst index 6741a75..394a984 100644 --- a/README.rst +++ b/README.rst @@ -104,6 +104,18 @@ License OAuthLib is yours to use and abuse according to the terms of the BSD license. Check the LICENSE file for full details. +Credits +------- + +OAuthLib has been started and maintained several years by Idan Gazit and other +amazing `AUTHORS`_. Thanks to their wonderful work, the open-source `community`_ +creation has been possible and the project can stay active and reactive to users +requests. + + +.. _`AUTHORS`: https://github.com/oauthlib/oauthlib/blob/master/AUTHORS +.. _`community`: https://github.com/oauthlib/ + Changelog --------- diff --git a/docs/conf.py b/docs/conf.py index 017f686..2594e38 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -41,7 +41,7 @@ master_doc = 'index' # General information about the project. project = u'OAuthLib' -copyright = u'2012, Idan Gazit and the Python Community' +copyright = u'2018, The OAuthlib Community' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the diff --git a/oauthlib/__init__.py b/oauthlib/__init__.py index b7586d2..bc5d96b 100644 --- a/oauthlib/__init__.py +++ b/oauthlib/__init__.py @@ -5,7 +5,7 @@ A generic, spec-compliant, thorough implementation of the OAuth request-signing logic. - :copyright: (c) 2011 by Idan Gazit. + :copyright: (c) 2018 by The OAuthlib Community :license: BSD, see LICENSE for details. """ import logging diff --git a/setup.py b/setup.py index 0c4e564..1d69e0d 100755 --- a/setup.py +++ b/setup.py @@ -33,7 +33,7 @@ setup( version=oauthlib.__version__, description='A generic, spec-compliant, thorough implementation of the OAuth request-signing logic', long_description=fread('README.rst'), - author='Idan Gazit', + author='The OAuthlib Community', author_email='idan@gazit.me', maintainer='Ib Lundgren', maintainer_email='ib.lundgren@gmail.com', -- cgit v1.2.1 From 7b2de403d591ddf70f6e9d21d4c5f55edad7642d Mon Sep 17 00:00:00 2001 From: Jonathan Huot Date: Mon, 19 Mar 2018 16:27:45 +0100 Subject: Fixed typo --- docs/release_process.rst | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/release_process.rst b/docs/release_process.rst index aab97c4..9ee987c 100644 --- a/docs/release_process.rst +++ b/docs/release_process.rst @@ -2,12 +2,12 @@ Release process =============== OAuthLib has got to a point where quite a few libraries and users depend on it. -Because of this a more careful release procedure will be introduced to make +Because of this, a more careful release procedure will be introduced to make sure all these lovely projects don't suddenly break. When approaching a release we will run the unittests for a set of downstream libraries using the unreleased version of OAuthLib. If OAuthLib is the cause of -failing tests we will either +failing tests we will either: 1. Find a way to introduce the change without breaking downstream. However, this is not always the best long term option. @@ -25,7 +25,7 @@ OAuthLib release issue on Github at least 2 days prior to release detailing the changes and pings the primary contacts for each downstream project. Please respond within those 2 days if you have major concerns. -How to get on the notifcations list +How to get on the notifications list ----------------------------------- Which projects and the instructions for testing each will be defined in @@ -45,8 +45,8 @@ A note on versioning -------------------- Historically OAuthLib has not been very good at semantic versioning but that -will change after the 1.0.0 release due late 2014. After that poing any major -digit release (e.g. 2.0.0) may introduce non backwards compatible changes. +has changed since the 1.0.0 in 2014. Since, any major digit release +(e.g. 2.0.0) may introduce non backwards compatible changes. Minor point (1.1.0) releases will introduce non API breaking new features and changes. Bug releases (1.0.1) will include minor fixes that needs to be released quickly (e.g. after a bigger release unintentionally introduced a -- cgit v1.2.1 From e18a4cf83745642080fa0a2233959cc52617c679 Mon Sep 17 00:00:00 2001 From: Jonathan Huot Date: Mon, 19 Mar 2018 16:27:33 +0100 Subject: Removed last occurences of G+ with Gitter --- docs/faq.rst | 6 +++--- docs/oauth1/server.rst | 4 ++-- docs/oauth2/server.rst | 4 ++-- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/faq.rst b/docs/faq.rst index 38b0e92..04c59ec 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -72,8 +72,8 @@ How do I use OAuthlib as a provider with Django, Flask and other web frameworks? - Pyramid `pyramid-oauthlib`_ - Bottle `bottle-oauthlib`_ - For other frameworks, please get in touch by opening a `GitHub issue`_, on `G+`_ or - on IRC #oauthlib irc.freenode.net. If you have written an OAuthLib package that + For other frameworks, please get in touch by opening a `GitHub issue`_ or + on `Gitter OAuthLib community`_. If you have written an OAuthLib package that supports your favorite framework, please open a Pull Request to update the docs. @@ -101,5 +101,5 @@ Some argue OAuth 2 is worse than 1, is that true? .. _`pyramid-oauthlib`: https://github.com/tilgovi/pyramid-oauthlib .. _`bottle-oauthlib`: https://github.com/thomsonreuters/bottle-oauthlib .. _`GitHub issue`: https://github.com/oauthlib/oauthlib/issues/new -.. _`G+`: https://plus.google.com/communities/101889017375384052571 +.. _`Gitter OAuthLib community`: https://gitter.im/oauthlib/Lobby .. _`difference`: https://www.cyberciti.biz/faq/authentication-vs-authorization/ diff --git a/docs/oauth1/server.rst b/docs/oauth1/server.rst index 2a91f30..db469d2 100644 --- a/docs/oauth1/server.rst +++ b/docs/oauth1/server.rst @@ -433,9 +433,9 @@ shown below as well as run your flask server locally on port `5000`. 7. Let us know how it went! --------------------------- -Drop a line in our `G+ community`_ or open a `GitHub issue`_ =) +Drop a line in our `Gitter OAuthLib community`_ or open a `GitHub issue`_ =) -.. _`G+ community`: https://plus.google.com/communities/101889017375384052571 +.. _`Gitter OAuthLib community`: https://gitter.im/oauthlib/Lobby .. _`GitHub issue`: https://github.com/oauthlib/oauthlib/issues/new If you run into issues it can be helpful to enable debug logging:: diff --git a/docs/oauth2/server.rst b/docs/oauth2/server.rst index 8f8b77b..35a58aa 100644 --- a/docs/oauth2/server.rst +++ b/docs/oauth2/server.rst @@ -493,9 +493,9 @@ at runtime by a function, rather then by a list. 6. Let us know how it went! --------------------------- -Drop a line in our `G+ community`_ or open a `GitHub issue`_ =) +Drop a line in our `Gitter OAuthLib community`_ or open a `GitHub issue`_ =) -.. _`G+ community`: https://plus.google.com/communities/101889017375384052571 +.. _`Gitter OAuthLib community`: https://gitter.im/oauthlib/Lobby .. _`GitHub issue`: https://github.com/oauthlib/oauthlib/issues/new If you run into issues it can be helpful to enable debug logging. -- cgit v1.2.1 From ed1a02442a20c82976bc84698c9a3f68e9d4631e Mon Sep 17 00:00:00 2001 From: Jonathan Huot Date: Mon, 19 Mar 2018 16:27:12 +0100 Subject: Mention our "extra" flags somewhere. --- docs/faq.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/faq.rst b/docs/faq.rst index 04c59ec..d9cd5c6 100644 --- a/docs/faq.rst +++ b/docs/faq.rst @@ -14,19 +14,23 @@ What parts of OAuth 1 & 2 are supported? OAuth 1 with RSA-SHA1 signatures says "could not import cryptography". What should I do? ---------------------------------------------------------------------------------- - Install cryptography via pip. + Install oauthlib with rsa flag or install cryptography manually via pip. .. code-block:: sh + $ pip install oauthlib[rsa] + ..or.. $ pip install cryptography OAuth 2 ServiceApplicationClient and OAuth 1 with RSA-SHA1 signatures say "could not import jwt". What should I do? ------------------------------------------------------------------------------------------------------------------- - Install pyjwt and cryptography with pip. + Install oauthlib with signedtoken flag or install pyjwt and cryptography manually with pip. .. code-block:: sh + $ pip install oauthlib[signedtoken] + ..or.. $ pip install pyjwt cryptography What does ValueError `Only unicode objects are escapable. Got one of type X.` mean? -- cgit v1.2.1 From 28d95db162aebfbdb6872141c70acf05e7fa2c20 Mon Sep 17 00:00:00 2001 From: Jonathan Huot Date: Mon, 19 Mar 2018 16:26:56 +0100 Subject: Added upstream test as best practice --- docs/contributing.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/contributing.rst b/docs/contributing.rst index 601c567..3c05f45 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -150,6 +150,17 @@ version. For Ubuntu you can easily install all after adding one ppa. .. _`Tox`: https://tox.readthedocs.io/en/latest/install.html .. _`virtualenv`: https://virtualenv.pypa.io/en/latest/installation/ +Test upstream applications +----------------------------------- + +Remember, OAuthLib is used by several 3rd party projects. If you think you +submit a breaking change, confirm that other projects builds are not affected. + +.. sourcecode:: bash + + $ make + + If you add code you need to add tests! -------------------------------------- -- cgit v1.2.1 From 6f4fbe666de3aaf6f3fca22705262665b4c23173 Mon Sep 17 00:00:00 2001 From: Jonathan Huot Date: Mon, 19 Mar 2018 16:26:38 +0100 Subject: Updated python versions --- docs/contributing.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index 3c05f45..d3d9a39 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -127,7 +127,7 @@ request that fails this test suite will be **rejected**. Testing multiple versions of Python ----------------------------------- -OAuthLib supports Python 2.6, 2.7, 3.2, 3.3 and experimentally PyPy. Testing +OAuthLib supports Python 2.7, 3.4, 3.5, 3.6 and PyPy. Testing all versions conveniently can be done using `Tox`_. .. sourcecode:: bash -- cgit v1.2.1 From e53203aa1a9daf9d5af1607900dc3d8b26a81aa0 Mon Sep 17 00:00:00 2001 From: Jonathan Huot Date: Mon, 19 Mar 2018 16:25:17 +0100 Subject: Fixed bad copy/paste --- docs/contributing.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index d3d9a39..3a23d70 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -35,7 +35,7 @@ Setting up topic branches and generating pull requests While it's handy to provide useful code snippets in an issue, it is better for you as a developer to submit pull requests. By submitting pull request your -contribution to OpenComparison will be recorded by Github. +contribution to OAuthlib will be recorded by Github. In git it is best to isolate each topic or feature into a "topic branch". While individual commits allow you control over how small individual changes are made @@ -218,7 +218,7 @@ How pull requests are checked, tested, and done First we pull the code into a local branch:: - git remote add git@github.com:/opencomparison.git + git remote add git@github.com:/oauthlib.git git fetch git checkout -b / -- cgit v1.2.1