chore: prepare for release

scrapli · Jan 28, 2023 · 4f21268 · 4f21268
1 parent b840427
commit 4f21268
Show file tree

Hide file tree

Showing 43 changed files with 81 additions and 8 deletions.
diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml
@@ -16,15 +16,13 @@ jobs:
       - name: setup publish env
         run: |
             python -m pip install --upgrade pip
-            python -m pip install setuptools
-            python -m pip install wheel
-            python -m pip install twine
+            python -m pip install setuptools wheel build twine
       - name: build and publish
         env:
           TWINE_USERNAME: ${{ secrets.PYPI_USER }}
           TWINE_PASSWORD: ${{ secrets.PYPI_PASS }}
         run: |
-          python setup.py sdist bdist_wheel
+          python -m build
           python -m twine upload dist/*
       - name: create release branch
         uses: peterjgrainger/[email protected]

diff --git a/.gitignore b/.gitignore
@@ -79,6 +79,7 @@ dmypy.json
 
 # private dir for notes and such
 private/
+.private/
 
 # log output
 *.log

diff --git a/docs/reference/SUMMARY.md b/docs/reference/SUMMARY.md
@@ -0,0 +1,37 @@
+* [diff](diff.md)
+* [exceptions](exceptions.md)
+* [factory](factory.md)
+* [helper](helper.md)
+* [logging](logging.md)
+* [platform](platform/index.md)
+    * [base](platform/base/index.md)
+        * [async_platform](platform/base/async_platform.md)
+        * [base_platform](platform/base/base_platform.md)
+        * [sync_platform](platform/base/sync_platform.md)
+    * [core](platform/core/index.md)
+        * [arista_eos](platform/core/arista_eos/index.md)
+            * [async_platform](platform/core/arista_eos/async_platform.md)
+            * [base_platform](platform/core/arista_eos/base_platform.md)
+            * [patterns](platform/core/arista_eos/patterns.md)
+            * [sync_platform](platform/core/arista_eos/sync_platform.md)
+        * [cisco_iosxe](platform/core/cisco_iosxe/index.md)
+            * [async_platform](platform/core/cisco_iosxe/async_platform.md)
+            * [base_platform](platform/core/cisco_iosxe/base_platform.md)
+            * [patterns](platform/core/cisco_iosxe/patterns.md)
+            * [sync_platform](platform/core/cisco_iosxe/sync_platform.md)
+        * [cisco_iosxr](platform/core/cisco_iosxr/index.md)
+            * [async_platform](platform/core/cisco_iosxr/async_platform.md)
+            * [base_platform](platform/core/cisco_iosxr/base_platform.md)
+            * [patterns](platform/core/cisco_iosxr/patterns.md)
+            * [sync_platform](platform/core/cisco_iosxr/sync_platform.md)
+        * [cisco_nxos](platform/core/cisco_nxos/index.md)
+            * [async_platform](platform/core/cisco_nxos/async_platform.md)
+            * [base_platform](platform/core/cisco_nxos/base_platform.md)
+            * [patterns](platform/core/cisco_nxos/patterns.md)
+            * [sync_platform](platform/core/cisco_nxos/sync_platform.md)
+        * [juniper_junos](platform/core/juniper_junos/index.md)
+            * [async_platform](platform/core/juniper_junos/async_platform.md)
+            * [base_platform](platform/core/juniper_junos/base_platform.md)
+            * [patterns](platform/core/juniper_junos/patterns.md)
+            * [sync_platform](platform/core/juniper_junos/sync_platform.md)
+* [response](response.md)
diff --git a/docs/reference/diff.md b/docs/reference/diff.md
@@ -0,0 +1 @@
+::: diff
diff --git a/docs/reference/exceptions.md b/docs/reference/exceptions.md
@@ -0,0 +1 @@
+::: exceptions
diff --git a/docs/reference/factory.md b/docs/reference/factory.md
@@ -0,0 +1 @@
+::: factory
diff --git a/docs/reference/helper.md b/docs/reference/helper.md
@@ -0,0 +1 @@
+::: helper
diff --git a/docs/reference/logging.md b/docs/reference/logging.md
@@ -0,0 +1 @@
+::: logging
diff --git a/docs/reference/platform/base/async_platform.md b/docs/reference/platform/base/async_platform.md
@@ -0,0 +1 @@
+::: platform.base.async_platform
diff --git a/docs/reference/platform/base/base_platform.md b/docs/reference/platform/base/base_platform.md
@@ -0,0 +1 @@
+::: platform.base.base_platform
diff --git a/docs/reference/platform/base/index.md b/docs/reference/platform/base/index.md
@@ -0,0 +1 @@
+::: platform.base
diff --git a/docs/reference/platform/base/sync_platform.md b/docs/reference/platform/base/sync_platform.md
@@ -0,0 +1 @@
+::: platform.base.sync_platform
diff --git a/docs/reference/platform/core/arista_eos/async_platform.md b/docs/reference/platform/core/arista_eos/async_platform.md
@@ -0,0 +1 @@
+::: platform.core.arista_eos.async_platform
diff --git a/docs/reference/platform/core/arista_eos/base_platform.md b/docs/reference/platform/core/arista_eos/base_platform.md
@@ -0,0 +1 @@
+::: platform.core.arista_eos.base_platform
diff --git a/docs/reference/platform/core/arista_eos/index.md b/docs/reference/platform/core/arista_eos/index.md
@@ -0,0 +1 @@
+::: platform.core.arista_eos
diff --git a/docs/reference/platform/core/arista_eos/patterns.md b/docs/reference/platform/core/arista_eos/patterns.md
@@ -0,0 +1 @@
+::: platform.core.arista_eos.patterns
diff --git a/docs/reference/platform/core/arista_eos/sync_platform.md b/docs/reference/platform/core/arista_eos/sync_platform.md
@@ -0,0 +1 @@
+::: platform.core.arista_eos.sync_platform
diff --git a/docs/reference/platform/core/cisco_iosxe/async_platform.md b/docs/reference/platform/core/cisco_iosxe/async_platform.md
@@ -0,0 +1 @@
+::: platform.core.cisco_iosxe.async_platform
diff --git a/docs/reference/platform/core/cisco_iosxe/base_platform.md b/docs/reference/platform/core/cisco_iosxe/base_platform.md
@@ -0,0 +1 @@
+::: platform.core.cisco_iosxe.base_platform
diff --git a/docs/reference/platform/core/cisco_iosxe/index.md b/docs/reference/platform/core/cisco_iosxe/index.md
@@ -0,0 +1 @@
+::: platform.core.cisco_iosxe
diff --git a/docs/reference/platform/core/cisco_iosxe/patterns.md b/docs/reference/platform/core/cisco_iosxe/patterns.md
@@ -0,0 +1 @@
+::: platform.core.cisco_iosxe.patterns
diff --git a/docs/reference/platform/core/cisco_iosxe/sync_platform.md b/docs/reference/platform/core/cisco_iosxe/sync_platform.md
@@ -0,0 +1 @@
+::: platform.core.cisco_iosxe.sync_platform
diff --git a/docs/reference/platform/core/cisco_iosxr/async_platform.md b/docs/reference/platform/core/cisco_iosxr/async_platform.md
@@ -0,0 +1 @@
+::: platform.core.cisco_iosxr.async_platform
diff --git a/docs/reference/platform/core/cisco_iosxr/base_platform.md b/docs/reference/platform/core/cisco_iosxr/base_platform.md
@@ -0,0 +1 @@
+::: platform.core.cisco_iosxr.base_platform
diff --git a/docs/reference/platform/core/cisco_iosxr/index.md b/docs/reference/platform/core/cisco_iosxr/index.md
@@ -0,0 +1 @@
+::: platform.core.cisco_iosxr
diff --git a/docs/reference/platform/core/cisco_iosxr/patterns.md b/docs/reference/platform/core/cisco_iosxr/patterns.md
@@ -0,0 +1 @@
+::: platform.core.cisco_iosxr.patterns
diff --git a/docs/reference/platform/core/cisco_iosxr/sync_platform.md b/docs/reference/platform/core/cisco_iosxr/sync_platform.md
@@ -0,0 +1 @@
+::: platform.core.cisco_iosxr.sync_platform
diff --git a/docs/reference/platform/core/cisco_nxos/async_platform.md b/docs/reference/platform/core/cisco_nxos/async_platform.md
@@ -0,0 +1 @@
+::: platform.core.cisco_nxos.async_platform
diff --git a/docs/reference/platform/core/cisco_nxos/base_platform.md b/docs/reference/platform/core/cisco_nxos/base_platform.md
@@ -0,0 +1 @@
+::: platform.core.cisco_nxos.base_platform
diff --git a/docs/reference/platform/core/cisco_nxos/index.md b/docs/reference/platform/core/cisco_nxos/index.md
@@ -0,0 +1 @@
+::: platform.core.cisco_nxos
diff --git a/docs/reference/platform/core/cisco_nxos/patterns.md b/docs/reference/platform/core/cisco_nxos/patterns.md
@@ -0,0 +1 @@
+::: platform.core.cisco_nxos.patterns
diff --git a/docs/reference/platform/core/cisco_nxos/sync_platform.md b/docs/reference/platform/core/cisco_nxos/sync_platform.md
@@ -0,0 +1 @@
+::: platform.core.cisco_nxos.sync_platform
diff --git a/docs/reference/platform/core/index.md b/docs/reference/platform/core/index.md
@@ -0,0 +1 @@
+::: platform.core
diff --git a/docs/reference/platform/core/juniper_junos/async_platform.md b/docs/reference/platform/core/juniper_junos/async_platform.md
@@ -0,0 +1 @@
+::: platform.core.juniper_junos.async_platform
diff --git a/docs/reference/platform/core/juniper_junos/base_platform.md b/docs/reference/platform/core/juniper_junos/base_platform.md
@@ -0,0 +1 @@
+::: platform.core.juniper_junos.base_platform
diff --git a/docs/reference/platform/core/juniper_junos/index.md b/docs/reference/platform/core/juniper_junos/index.md
@@ -0,0 +1 @@
+::: platform.core.juniper_junos
diff --git a/docs/reference/platform/core/juniper_junos/patterns.md b/docs/reference/platform/core/juniper_junos/patterns.md
@@ -0,0 +1 @@
+::: platform.core.juniper_junos.patterns
diff --git a/docs/reference/platform/core/juniper_junos/sync_platform.md b/docs/reference/platform/core/juniper_junos/sync_platform.md
@@ -0,0 +1 @@
+::: platform.core.juniper_junos.sync_platform
diff --git a/docs/reference/platform/index.md b/docs/reference/platform/index.md
@@ -0,0 +1 @@
+::: platform
diff --git a/docs/reference/response.md b/docs/reference/response.md
@@ -0,0 +1 @@
+::: response
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,5 +1,5 @@
 [build-system]
-requires = ["setuptools"]
+requires = ["setuptools", "wheel"]
 build-backend = "setuptools.build_meta"
 
 [project]
@@ -87,7 +87,7 @@ asyncio_mode = "auto"
 
 [tool.pylama]
 linters = "mccabe,pycodestyle,pylint"
-skip = ".nox/*,build/*,docs/*,private/*,site/*,tests/*,venv/*"
+skip = ".nox/*,.private/*,build/*,docs/*,private/*,site/*,tests/*,venv/*"
 
 [tool.pylama.pycodestyle]
 max_line_length = 100

diff --git a/requirements-docs.txt b/requirements-docs.txt
@@ -2,7 +2,7 @@ mdx-gh-links>=0.2,<1.0
 mkdocs>=1.2.3,<2.0.0
 mkdocs-gen-files>=0.4.0,<1.0.0
 mkdocs-literate-nav>=0.5.0,<1.0.0
-mkdocs-material>=8.1.6,<9.0.0
+mkdocs-material>=8.1.6,<10.0.0
 mkdocs-material-extensions>=1.0.3,<2.0.0
 mkdocs-section-index>=0.3.4,<1.0.0
 mkdocstrings[python]>=0.19.0,<1.0.0
diff --git a/scrapli_cfg/__init__.py b/scrapli_cfg/__init__.py
@@ -1,7 +1,7 @@
 """scrapli_cfg"""
 from scrapli_cfg.factory import AsyncScrapliCfg, ScrapliCfg
 
-__version__ = "2022.07.30"
+__version__ = "2023.01.30"
 
 __all__ = (
     "AsyncScrapliCfg",