Merge pull request #107 from pallets/split

Refactor from single module to package
pallets · Oct 18, 2018 · 8e611d7 · 8e611d7
2 parents 7bd9f35 + a8c7d1b
commit 8e611d7
Show file tree

Hide file tree

Showing 40 changed files with 1,892 additions and 1,598 deletions.
diff --git a/.gitignore b/.gitignore
@@ -2,6 +2,7 @@
 *.pyo
 __pycache__/
 .idea/
+.vscode/
 .DS_Store
 env/
 venv/
@@ -15,3 +16,4 @@ docs/_build/
 .coverage
 .coverage.*
 htmlcov/
+.hypothesis/
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/asottile/reorder_python_imports
-    rev: v1.2.0
+    rev: v1.3.1
     hooks:
       - id: reorder-python-imports
         args: ["--application-directories", "src"]
@@ -9,6 +9,10 @@ repos:
     hooks:
       - id: black
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v1.4.0
+    rev: v2.0.0
     hooks:
+      - id: check-byte-order-marker
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
       - id: flake8
+        additional_dependencies: [flake8-bugbear]
diff --git a/.travis.yml b/.travis.yml
@@ -25,7 +25,9 @@ script:
   - tox
 
 cache:
-  - pip
+  directories:
+    - $HOME/.cache/pip
+    - $HOME/.cache/pre-commit
 
 branches:
   only:

diff --git a/CHANGES.rst b/CHANGES.rst
@@ -4,6 +4,10 @@ Version 1.0
 Unreleased
 
 -   Drop support for Python 2.6 and 3.3.
+-   Refactor code from a single module to a package. Any object in the
+    API docs is still importable from the top-level ``itsdangerous``
+    name, but other imports will need to be changed. A future release
+    will remove many of these compatibility imports.
 -   Optimize how timestamps are serialized and deserialized. (`#13`_)
 -   ``base64_decode`` raises ``BadData`` when it is passed invalid data.
     (`#27`_)

diff --git a/LICENSE.rst b/LICENSE.rst
@@ -44,4 +44,4 @@ The initial implementation of It's Dangerous was inspired by Django's
 signing module.
 
 Copyright © Django Software Foundation and individual contributors.
-All rights reserved.
+All rights reserved.
diff --git a/docs/Makefile b/docs/Makefile
@@ -4,7 +4,6 @@
 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = ItsDangerous
 SOURCEDIR     = .
 BUILDDIR      = _build
 

diff --git a/docs/_static/itsdangerous-logo-sidebar.png b/docs/_static/itsdangerous-logo-sidebar.png
diff --git a/docs/changes.rst b/docs/changes.rst
@@ -0,0 +1,4 @@
+Changes
+=======
+
+.. include:: ../CHANGES.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -27,12 +27,15 @@
         ProjectLink("Issue Tracker", "https://github.com/pallets/itsdangerous/issues/"),
     ]
 }
-html_sidebars = {"index": ["project.html", "localtoc.html", "versions.html"]}
+html_sidebars = {
+    "index": ["project.html", "localtoc.html", "searchbox.html"],
+    "**": ["localtoc.html", "relations.html", "searchbox.html"],
+}
+singlehtml_sidebars = {"index": ["project.html", "localtoc.html"]}
 html_static_path = ["_static"]
+html_logo = "_static/itsdangerous-logo-sidebar.png"
 html_title = "It's Dangerous Documentation ({})".format(version)
 html_show_sourcelink = False
-html_domain_indices = False
-html_experimental_html5_writer = True
 
 # LaTeX ----------------------------------------------------------------
 

diff --git a/docs/encoding.rst b/docs/encoding.rst
@@ -0,0 +1,8 @@
+.. module:: itsdangerous.encoding
+
+Encoding Utilities
+==================
+
+.. autofunction:: base64_encode
+
+.. autofunction:: base64_decode
diff --git a/docs/exceptions.rst b/docs/exceptions.rst
@@ -0,0 +1,22 @@
+.. module:: itsdangerous.exc
+
+Exceptions
+==========
+
+.. autoexception:: BadData
+    :members:
+
+.. autoexception:: BadSignature
+    :members:
+
+.. autoexception:: BadTimeSignature
+    :members:
+
+.. autoexception:: SignatureExpired
+    :members:
+
+.. autoexception:: BadHeader
+    :members:
+
+.. autoexception:: BadPayload
+    :members: