Merge branch 'release/1.0.0'

Author: fgmacedo

.coveragerc

@@ -7,6 +7,7 @@ omit =
     *test*.py
     tmp/*
     pytest_cov
+    statemachine/factory_2.py
 
 [report]
 show_missing = True

.flake8

@@ -1,3 +1,4 @@
 [flake8]
 max-line-length = 99
 exclude = .git/*,.tox/*,docs/*,dist/*,build/*
+ignore = E231,W503

.git-blame-ignore-revs

@@ -0,0 +1,4 @@
+37fcf9818178587635fffe1bb67a9fd5024a0a45
+345d82390af35d5d70ddd39c612faa4a64b11080
+d7738e9ad0a3e50bc5c87d4a75c436fb771c96f6
+5bf10afae2b214900aa58dd44b0a91e469c70631

.gitignore

@@ -25,6 +25,10 @@ var/
 *.egg
 .mypy_cache
 
+# jupyter
+.ipynb_checkpoints/
+.jupyterlite.doit.db
+
 # PyInstaller
 #  Usually these files are written by a python script from a template
 #  before PyInstaller builds the exe, so as to inject date/other infos into it.
@@ -67,3 +71,7 @@ target/
 *.sublime*
 .idea/
 .vscode/
+
+# Sphinx-galery
+docs/auto_examples/sg_execution_times.*
+docs/auto_examples/*.pickle

.pre-commit-config.yaml

@@ -0,0 +1,17 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+    -   id: check-yaml
+    -   id: end-of-file-fixer
+        exclude: docs/auto_examples
+    -   id: trailing-whitespace
+        exclude: docs/auto_examples
+-   repo: https://github.com/psf/black
+    rev: 22.10.0
+    hooks:
+    -   id: black
+-   repo: https://github.com/asottile/reorder_python_imports
+    rev: v3.9.0
+    hooks:
+    -   id: reorder-python-imports

.readthedocs.yaml

@@ -0,0 +1,20 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-20.04
+  tools:
+    python: "3.8"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+python:
+   install:
+   - requirements: docs/requirements.txt

AUTHORS.rst

@@ -15,11 +15,10 @@ Contributors
 * Raphael Schrader <[email protected]>
 
 
-Credits
--------
+Scaffolding
+-----------
 
 This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
 
 .. _Cookiecutter: https://github.com/audreyr/cookiecutter
 .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
-

CONTRIBUTING.rst

@@ -76,17 +76,39 @@ Ready to contribute? Here's how to set up `python-statemachine` for local develo
 
    Now you can make your changes locally.
 
-5. When you're done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox::
+5. When you're done making changes, check that your changes pass flake8 and the tests, including
+   testing other Python versions with tox::
 
     $ flake8 statemachine tests
-    $ python setup.py test or py.test
+    $ py.test
     $ tox
 
    To get flake8 and tox, just pip install them into your virtualenv.
 
+6. To build the documentation locally, run::
+
+    $ sphinx-build docs docs/_build/html
+
+   Now you can serve the local documentation using a webserver, like the built-in included
+   with python::
+
+    $ python -m http.server --directory docs/_build/html
+
+   And access your browser at http://localhost:8000/
+
+   If you're specially writting documentation, I strongly recommend using ``sphinx-autobuild``
+   as it improves the workflow watching for file changes and with live reloading::
+
+    $ sphinx-autobuild docs docs/_build/html --re-ignore "auto_examples/.*"
+
+   Sometimes you need a full fresh of the files being build for docs, you can use::
+
+    $ rm -rf docs/_build/ docs/auto_examples
+
 .. note::
 
-    In order to get the tox working for all versions, I usually run pyenv enabling shell for those versions:
+    In order to get the tox working for all versions, I usually run pyenv enabling shell for
+    those versions::
 
     $ pyenv shell 3.8.1/envs/python-statemachine 3.7.6 3.6.10 3.5.9 2.7.17
 
@@ -117,4 +139,3 @@ Tips
 To run a subset of tests::
 
 $ py.test tests.test_statemachine
-

HISTORY.rst

@@ -8,4 +8,3 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
 
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-