chore: prepare for release

scrapli · Jan 28, 2023 · f595b71 · f595b71
1 parent 848e4f2
commit f595b71
Show file tree

Hide file tree

Showing 28 changed files with 51 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,22 @@
+* [channel](channel/index.md)
+    * [async_channel](channel/async_channel.md)
+    * [base_channel](channel/base_channel.md)
+    * [sync_channel](channel/sync_channel.md)
+* [constants](constants.md)
+* [driver](driver/index.md)
+    * [async_driver](driver/async_driver.md)
+    * [base_driver](driver/base_driver.md)
+    * [sync_driver](driver/sync_driver.md)
+* [exceptions](exceptions.md)
+* [helper](helper.md)
+* [response](response.md)
+* [transport](transport/index.md)
+    * [plugins](transport/plugins/index.md)
+        * [asyncssh](transport/plugins/asyncssh/index.md)
+            * [transport](transport/plugins/asyncssh/transport.md)
+        * [paramiko](transport/plugins/paramiko/index.md)
+            * [transport](transport/plugins/paramiko/transport.md)
+        * [ssh2](transport/plugins/ssh2/index.md)
+            * [transport](transport/plugins/ssh2/transport.md)
+        * [system](transport/plugins/system/index.md)
+            * [transport](transport/plugins/system/transport.md)
diff --git a/docs/reference/channel/async_channel.md b/docs/reference/channel/async_channel.md
@@ -0,0 +1 @@
+::: channel.async_channel
diff --git a/docs/reference/channel/base_channel.md b/docs/reference/channel/base_channel.md
@@ -0,0 +1 @@
+::: channel.base_channel
diff --git a/docs/reference/channel/index.md b/docs/reference/channel/index.md
@@ -0,0 +1 @@
+::: channel
diff --git a/docs/reference/channel/sync_channel.md b/docs/reference/channel/sync_channel.md
@@ -0,0 +1 @@
+::: channel.sync_channel
diff --git a/docs/reference/constants.md b/docs/reference/constants.md
@@ -0,0 +1 @@
+::: constants
diff --git a/docs/reference/driver/async_driver.md b/docs/reference/driver/async_driver.md
@@ -0,0 +1 @@
+::: driver.async_driver
diff --git a/docs/reference/driver/base_driver.md b/docs/reference/driver/base_driver.md
@@ -0,0 +1 @@
+::: driver.base_driver
diff --git a/docs/reference/driver/index.md b/docs/reference/driver/index.md
@@ -0,0 +1 @@
+::: driver
diff --git a/docs/reference/driver/sync_driver.md b/docs/reference/driver/sync_driver.md
@@ -0,0 +1 @@
+::: driver.sync_driver
diff --git a/docs/reference/exceptions.md b/docs/reference/exceptions.md
@@ -0,0 +1 @@
+::: exceptions
diff --git a/docs/reference/helper.md b/docs/reference/helper.md
@@ -0,0 +1 @@
+::: helper
diff --git a/docs/reference/response.md b/docs/reference/response.md
@@ -0,0 +1 @@
+::: response
diff --git a/docs/reference/transport/index.md b/docs/reference/transport/index.md
@@ -0,0 +1 @@
+::: transport
diff --git a/docs/reference/transport/plugins/asyncssh/index.md b/docs/reference/transport/plugins/asyncssh/index.md
@@ -0,0 +1 @@
+::: transport.plugins.asyncssh
diff --git a/docs/reference/transport/plugins/asyncssh/transport.md b/docs/reference/transport/plugins/asyncssh/transport.md
@@ -0,0 +1 @@
+::: transport.plugins.asyncssh.transport
diff --git a/docs/reference/transport/plugins/index.md b/docs/reference/transport/plugins/index.md
@@ -0,0 +1 @@
+::: transport.plugins
diff --git a/docs/reference/transport/plugins/paramiko/index.md b/docs/reference/transport/plugins/paramiko/index.md
@@ -0,0 +1 @@
+::: transport.plugins.paramiko
diff --git a/docs/reference/transport/plugins/paramiko/transport.md b/docs/reference/transport/plugins/paramiko/transport.md
@@ -0,0 +1 @@
+::: transport.plugins.paramiko.transport
diff --git a/docs/reference/transport/plugins/ssh2/index.md b/docs/reference/transport/plugins/ssh2/index.md
@@ -0,0 +1 @@
+::: transport.plugins.ssh2
diff --git a/docs/reference/transport/plugins/ssh2/transport.md b/docs/reference/transport/plugins/ssh2/transport.md
@@ -0,0 +1 @@
+::: transport.plugins.ssh2.transport
diff --git a/docs/reference/transport/plugins/system/index.md b/docs/reference/transport/plugins/system/index.md
@@ -0,0 +1 @@
+::: transport.plugins.system
diff --git a/docs/reference/transport/plugins/system/transport.md b/docs/reference/transport/plugins/system/transport.md
@@ -0,0 +1 @@
+::: transport.plugins.system.transport
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_netconf/__init__.py b/scrapli_netconf/__init__.py
@@ -1,7 +1,7 @@
 """scrapli_netconf"""
 from scrapli_netconf.driver import AsyncNetconfDriver, NetconfDriver
 
-__version__ = "2022.07.30"
+__version__ = "2023.01.30"
 
 __all__ = (
     "NetconfDriver",