summaryrefslogtreecommitdiff
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* Require tweak (#280)Pau Ruiz Safont2020-05-141-0/+10
| | | | | | | | | | | * Use require options as a list, instead of booleans Deprecate the use of the boolean options * Add test for the new require option * Add documentation on how to use the require option Co-authored-by: Pau Ruiz i Safont <psafont@ebi.ac.uk>
* Document top-level .encode and .decode to close #459 (#482)Dima Tisnek2020-04-262-4/+64
| | | Co-authored-by: José Padilla <jpadilla@webapplicate.com>
* Improve documentation for audience usage (#484)Correy Lim2020-04-261-8/+35
| | | | | | | | | | | | | | | | | | | | | | | * Add code example for `aud` being an array The previous code example only showed the `aud` claim as a single case-sensitive string, despite the documentation mentioning that the `aud` claim can be an array of case-sensitive strings Add a code block demonstrating the `aud` claim being an array of case-sensitive strings to make it more clear to the user that it is a permitted use of the `aud` claim * Add example of the `audience` param as an iterable Demonstrate to users reading the documentation that the `audience` parameter is not restricted to the `string` type, but can also accept an iterable, as implemented in PR#306 https://github.com/jpadilla/pyjwt/pull/306 * Fix short title underlines Short title underlines throw warnings in reStructuredText linters
* DX Tweaks (#450)José Padilla2019-10-213-87/+93
| | | | | | | | | | * Setup pre-commit hooks * Run initial `tox -e lint` * Fix package name * Fix .travis.yml
* Document (and prefer) `pyjwt[crypto]` req format (#426)Gunnlaugur Thor Briem2019-06-121-2/+7
|
* Fixes example invocations in README.rst and docs/index.rst. (#368)Debayan De2018-08-141-2/+2
| | | Signed-off-by: Debayan De <debayande@users.noreply.github.com>
* Update usage.rst (#360)PatrikBillgren2018-07-191-1/+1
| | | Small typo fix
* Added section to usage docs for jwt.get_unverified_header() (#350)Alejandro J. C De Baca2018-05-191-0/+14
|
* Update legacy instructions for using pycrypto (#337)Casey2018-03-221-0/+3
| | | Related to #181 where users see `ValueError: Algorithm already has a handler.` after trying to register pycrypto algorithms.
* Add missing close quote. (#327)Stephen Paulger2018-01-231-1/+1
|
* Fix hyperlink formatting in algorithms.rst (#324)tornato72018-01-151-1/+1
|
* Fix #315: Raise InvalidSignatureError over generic DecodeError (#316)Markus Holtermann2017-12-011-0/+5
|
* docs: Add example of encoding and decoding tokens with RSA (#313)Mark Adams2017-11-281-2/+17
| | | | | | | | | | * docs: Add example of encoding and decoding tokens with RSA Some users have complained that the docs don't make it very clear that the private key / public key need to be a byte string. This change makes that clearer by adding an example to usage.rst. * flake8: Fix a couple of linting errors due to a new version of flake8-import-order
* Fix sphinx warningJosé Padilla2017-10-182-2/+2
|
* Fix sponsor banner in docsJosé Padilla2017-10-183-3/+27
|
* Add Auth0 sponsor bannerJosé Padilla2017-10-181-0/+9
|
* Prevent needing to scroll on jwt.decode exampleLandon GB2017-07-281-2/+3
|
* Add 'algorithms=[]' kwargs to jwt.decode() examplesLandon GB2017-07-282-6/+6
| | | | Added because of this commit: 11f30c4050a11b6398d38f505578c9dabeba6c78
* Update algorithms.rstMarek Siarkowicz2017-05-291-1/+1
|
* Added Command line instructions to README and docsMariano Ruiz2017-05-061-3/+19
|
* Added requirements to install docs build toolsMariano Ruiz2017-05-061-0/+3
|
* Non-numeric 'iat' now raises InvalidIssuedAtError on decode()190-remove-iat-verificationMark Adams2017-04-171-0/+2
|
* Stop rejecting tokens with future 'iat' valuesMark Adams2017-04-171-3/+0
| | | | | | | | | | RFC 7519 does not specify or even suggest this type of validation on the 'iat' claim and it has caused issues for several consumers of PyJWT. This change removes the validation on future 'iat' values and leaves such things up to the application developer to implement. Fixes #190.
* Be specific for Python2 and Python3David Binetti2017-03-281-3/+11
|
* Update FAQ to clarify Python2/3 differencesDavid Binetti2017-03-281-0/+5
|
* Fix typo in rstMichael Collis2016-09-211-1/+1
|
* Fix imports in code exampleMatti John2015-11-111-2/+2
|
* Added docs/ with awesome new documentation 🎉Mark Adams2015-10-238-0/+909