Merge pull request #137 from glyph/typical

add a new type-safe interface to the library

.coveragerc

@@ -0,0 +1,8 @@
+[report]
+precision = 2
+ignore_errors = True
+exclude_lines =
+    pragma: no cover
+    if TYPE_CHECKING
+    \s*\.\.\.$
+    raise NotImplementedError

.github/workflows/ci.yml

@@ -16,7 +16,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python: ["3.10", "3.11"]
+        python: ["3.8", "3.10", "3.11"]
         TOX_ENV: ["extras", "noextras", "mypy"]
         include:
           - python: "3.11"
@@ -28,17 +28,24 @@ jobs:
         uses: actions/setup-python@v3
         with:
           python-version: ${{ matrix.python }}
+      - name: Install graphviz
+        run: |
+          sudo apt-get install -y graphviz
+          dot -V
+        if: ${{ matrix.TOX_ENV == 'extras' }}
       - name: Tox Run
         run:  |
           pip install tox;
-          TOX_ENV="py$(echo ${{ matrix.python }} | sed -e s/\.//g)-${{ matrix.TOX_ENV }}";
+          TOX_ENV="py$(echo ${{ matrix.python }} | sed -e 's/\.//g')-${{ matrix.TOX_ENV }}";
           echo "Starting: ${TOX_ENV} ${PUSH_DOCS}"
           if [[ -n "${TOX_ENV}" ]]; then
             tox -e "$TOX_ENV";
-            if [[ "${{ matrix.TOX_ENV }}" != "mypy" ]]; then
+            if [[ "${{ matrix.TOX_ENV }}" != "mypy" && "${{ matrix.TOX_ENV }}" != "lint" ]]; then
               tox -e coverage-report;
             fi;
           fi;
       - name: Upload coverage report
         if: ${{ matrix.TOX_ENV != 'mypy' }}
-        uses: codecov/[email protected]
+        uses: codecov/[email protected]
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}

.gitignore

@@ -1,8 +1,10 @@
 .tox/
-.coverage*
+.coverage.*
 .eggs/
 *.egg-info/
 *.py[co]
 build/
 dist/
 docs/_build/
+coverage.xml
+

.pydoctor.cfg

@@ -0,0 +1,23 @@
+[tool:pydoctor]
+quiet=1
+warnings-as-errors=true
+project-name=Automat
+project-url=../index.html
+docformat=epytext
+theme=readthedocs
+intersphinx=
+    https://graphviz.readthedocs.io/en/stable/objects.inv
+    https://docs.python.org/3/objects.inv
+    https://cryptography.io/en/latest/objects.inv
+    https://pyopenssl.readthedocs.io/en/stable/objects.inv
+    https://hyperlink.readthedocs.io/en/stable/objects.inv
+    https://twisted.org/constantly/docs/objects.inv
+    https://twisted.org/incremental/docs/objects.inv
+    https://python-hyper.org/projects/hyper-h2/en/stable/objects.inv
+    https://priority.readthedocs.io/en/stable/objects.inv
+    https://zopeinterface.readthedocs.io/en/latest/objects.inv
+    https://automat.readthedocs.io/en/latest/objects.inv
+    https://docs.twisted.org/en/stable/objects.inv
+project-base-dir=automat
+html-output=docs/_build/api
+html-viewsource-base=https://github.com/glyph/automat/tree/trunk

.readthedocs.yaml

@@ -0,0 +1,35 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+    # You can also specify other tool versions:
+    # nodejs: "20"
+    # rust: "1.70"
+    # golang: "1.20"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
+  # builder: "dirhtml"
+  # Fail on all warnings to avoid broken references
+  # fail_on_warning: true
+
+# Optionally build your docs in additional formats such as PDF and ePub
+# formats:
+#   - pdf
+#   - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt