From 4f21268ee839e7a3b25e09a4c47db1cd07ce086c Mon Sep 17 00:00:00 2001 From: Carl Montanari Date: Sat, 28 Jan 2023 11:33:55 -0800 Subject: [PATCH] chore: prepare for release --- .github/workflows/publish.yaml | 6 +-- .gitignore | 1 + docs/reference/SUMMARY.md | 37 +++++++++++++++++++ docs/reference/diff.md | 1 + docs/reference/exceptions.md | 1 + docs/reference/factory.md | 1 + docs/reference/helper.md | 1 + docs/reference/logging.md | 1 + .../reference/platform/base/async_platform.md | 1 + docs/reference/platform/base/base_platform.md | 1 + docs/reference/platform/base/index.md | 1 + docs/reference/platform/base/sync_platform.md | 1 + .../core/arista_eos/async_platform.md | 1 + .../platform/core/arista_eos/base_platform.md | 1 + .../platform/core/arista_eos/index.md | 1 + .../platform/core/arista_eos/patterns.md | 1 + .../platform/core/arista_eos/sync_platform.md | 1 + .../core/cisco_iosxe/async_platform.md | 1 + .../core/cisco_iosxe/base_platform.md | 1 + .../platform/core/cisco_iosxe/index.md | 1 + .../platform/core/cisco_iosxe/patterns.md | 1 + .../core/cisco_iosxe/sync_platform.md | 1 + .../core/cisco_iosxr/async_platform.md | 1 + .../core/cisco_iosxr/base_platform.md | 1 + .../platform/core/cisco_iosxr/index.md | 1 + .../platform/core/cisco_iosxr/patterns.md | 1 + .../core/cisco_iosxr/sync_platform.md | 1 + .../core/cisco_nxos/async_platform.md | 1 + .../platform/core/cisco_nxos/base_platform.md | 1 + .../platform/core/cisco_nxos/index.md | 1 + .../platform/core/cisco_nxos/patterns.md | 1 + .../platform/core/cisco_nxos/sync_platform.md | 1 + docs/reference/platform/core/index.md | 1 + .../core/juniper_junos/async_platform.md | 1 + .../core/juniper_junos/base_platform.md | 1 + .../platform/core/juniper_junos/index.md | 1 + .../platform/core/juniper_junos/patterns.md | 1 + .../core/juniper_junos/sync_platform.md | 1 + docs/reference/platform/index.md | 1 + docs/reference/response.md | 1 + pyproject.toml | 4 +- requirements-docs.txt | 2 +- scrapli_cfg/__init__.py | 2 +- 43 files changed, 81 insertions(+), 8 deletions(-) create mode 100644 docs/reference/SUMMARY.md create mode 100644 docs/reference/diff.md create mode 100644 docs/reference/exceptions.md create mode 100644 docs/reference/factory.md create mode 100644 docs/reference/helper.md create mode 100644 docs/reference/logging.md create mode 100644 docs/reference/platform/base/async_platform.md create mode 100644 docs/reference/platform/base/base_platform.md create mode 100644 docs/reference/platform/base/index.md create mode 100644 docs/reference/platform/base/sync_platform.md create mode 100644 docs/reference/platform/core/arista_eos/async_platform.md create mode 100644 docs/reference/platform/core/arista_eos/base_platform.md create mode 100644 docs/reference/platform/core/arista_eos/index.md create mode 100644 docs/reference/platform/core/arista_eos/patterns.md create mode 100644 docs/reference/platform/core/arista_eos/sync_platform.md create mode 100644 docs/reference/platform/core/cisco_iosxe/async_platform.md create mode 100644 docs/reference/platform/core/cisco_iosxe/base_platform.md create mode 100644 docs/reference/platform/core/cisco_iosxe/index.md create mode 100644 docs/reference/platform/core/cisco_iosxe/patterns.md create mode 100644 docs/reference/platform/core/cisco_iosxe/sync_platform.md create mode 100644 docs/reference/platform/core/cisco_iosxr/async_platform.md create mode 100644 docs/reference/platform/core/cisco_iosxr/base_platform.md create mode 100644 docs/reference/platform/core/cisco_iosxr/index.md create mode 100644 docs/reference/platform/core/cisco_iosxr/patterns.md create mode 100644 docs/reference/platform/core/cisco_iosxr/sync_platform.md create mode 100644 docs/reference/platform/core/cisco_nxos/async_platform.md create mode 100644 docs/reference/platform/core/cisco_nxos/base_platform.md create mode 100644 docs/reference/platform/core/cisco_nxos/index.md create mode 100644 docs/reference/platform/core/cisco_nxos/patterns.md create mode 100644 docs/reference/platform/core/cisco_nxos/sync_platform.md create mode 100644 docs/reference/platform/core/index.md create mode 100644 docs/reference/platform/core/juniper_junos/async_platform.md create mode 100644 docs/reference/platform/core/juniper_junos/base_platform.md create mode 100644 docs/reference/platform/core/juniper_junos/index.md create mode 100644 docs/reference/platform/core/juniper_junos/patterns.md create mode 100644 docs/reference/platform/core/juniper_junos/sync_platform.md create mode 100644 docs/reference/platform/index.md create mode 100644 docs/reference/response.md diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml index 35a7cbf..bba08dc 100644 --- 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/action-create-branch@v2.4.0 diff --git a/.gitignore b/.gitignore index 32fe4bd..2d6216f 100644 --- 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 new file mode 100644 index 0000000..96d0031 --- /dev/null +++ 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 new file mode 100644 index 0000000..dc73753 --- /dev/null +++ b/docs/reference/diff.md @@ -0,0 +1 @@ +::: diff \ No newline at end of file diff --git a/docs/reference/exceptions.md b/docs/reference/exceptions.md new file mode 100644 index 0000000..d9a7e28 --- /dev/null +++ b/docs/reference/exceptions.md @@ -0,0 +1 @@ +::: exceptions \ No newline at end of file diff --git a/docs/reference/factory.md b/docs/reference/factory.md new file mode 100644 index 0000000..67e618c --- /dev/null +++ b/docs/reference/factory.md @@ -0,0 +1 @@ +::: factory \ No newline at end of file diff --git a/docs/reference/helper.md b/docs/reference/helper.md new file mode 100644 index 0000000..831de3f --- /dev/null +++ b/docs/reference/helper.md @@ -0,0 +1 @@ +::: helper \ No newline at end of file diff --git a/docs/reference/logging.md b/docs/reference/logging.md new file mode 100644 index 0000000..479db4f --- /dev/null +++ b/docs/reference/logging.md @@ -0,0 +1 @@ +::: logging \ No newline at end of file diff --git a/docs/reference/platform/base/async_platform.md b/docs/reference/platform/base/async_platform.md new file mode 100644 index 0000000..49463c0 --- /dev/null +++ b/docs/reference/platform/base/async_platform.md @@ -0,0 +1 @@ +::: platform.base.async_platform \ No newline at end of file diff --git a/docs/reference/platform/base/base_platform.md b/docs/reference/platform/base/base_platform.md new file mode 100644 index 0000000..6a03c7a --- /dev/null +++ b/docs/reference/platform/base/base_platform.md @@ -0,0 +1 @@ +::: platform.base.base_platform \ No newline at end of file diff --git a/docs/reference/platform/base/index.md b/docs/reference/platform/base/index.md new file mode 100644 index 0000000..a78db89 --- /dev/null +++ b/docs/reference/platform/base/index.md @@ -0,0 +1 @@ +::: platform.base \ No newline at end of file diff --git a/docs/reference/platform/base/sync_platform.md b/docs/reference/platform/base/sync_platform.md new file mode 100644 index 0000000..053776e --- /dev/null +++ b/docs/reference/platform/base/sync_platform.md @@ -0,0 +1 @@ +::: platform.base.sync_platform \ No newline at end of file diff --git a/docs/reference/platform/core/arista_eos/async_platform.md b/docs/reference/platform/core/arista_eos/async_platform.md new file mode 100644 index 0000000..b546dca --- /dev/null +++ b/docs/reference/platform/core/arista_eos/async_platform.md @@ -0,0 +1 @@ +::: platform.core.arista_eos.async_platform \ No newline at end of file diff --git a/docs/reference/platform/core/arista_eos/base_platform.md b/docs/reference/platform/core/arista_eos/base_platform.md new file mode 100644 index 0000000..81fe3ed --- /dev/null +++ b/docs/reference/platform/core/arista_eos/base_platform.md @@ -0,0 +1 @@ +::: platform.core.arista_eos.base_platform \ No newline at end of file diff --git a/docs/reference/platform/core/arista_eos/index.md b/docs/reference/platform/core/arista_eos/index.md new file mode 100644 index 0000000..e3c40b8 --- /dev/null +++ b/docs/reference/platform/core/arista_eos/index.md @@ -0,0 +1 @@ +::: platform.core.arista_eos \ No newline at end of file diff --git a/docs/reference/platform/core/arista_eos/patterns.md b/docs/reference/platform/core/arista_eos/patterns.md new file mode 100644 index 0000000..8ea7b96 --- /dev/null +++ b/docs/reference/platform/core/arista_eos/patterns.md @@ -0,0 +1 @@ +::: platform.core.arista_eos.patterns \ No newline at end of file diff --git a/docs/reference/platform/core/arista_eos/sync_platform.md b/docs/reference/platform/core/arista_eos/sync_platform.md new file mode 100644 index 0000000..fe787dc --- /dev/null +++ b/docs/reference/platform/core/arista_eos/sync_platform.md @@ -0,0 +1 @@ +::: platform.core.arista_eos.sync_platform \ No newline at end of file diff --git a/docs/reference/platform/core/cisco_iosxe/async_platform.md b/docs/reference/platform/core/cisco_iosxe/async_platform.md new file mode 100644 index 0000000..d627e38 --- /dev/null +++ b/docs/reference/platform/core/cisco_iosxe/async_platform.md @@ -0,0 +1 @@ +::: platform.core.cisco_iosxe.async_platform \ No newline at end of file diff --git a/docs/reference/platform/core/cisco_iosxe/base_platform.md b/docs/reference/platform/core/cisco_iosxe/base_platform.md new file mode 100644 index 0000000..b338369 --- /dev/null +++ b/docs/reference/platform/core/cisco_iosxe/base_platform.md @@ -0,0 +1 @@ +::: platform.core.cisco_iosxe.base_platform \ No newline at end of file diff --git a/docs/reference/platform/core/cisco_iosxe/index.md b/docs/reference/platform/core/cisco_iosxe/index.md new file mode 100644 index 0000000..d9518ca --- /dev/null +++ b/docs/reference/platform/core/cisco_iosxe/index.md @@ -0,0 +1 @@ +::: platform.core.cisco_iosxe \ No newline at end of file diff --git a/docs/reference/platform/core/cisco_iosxe/patterns.md b/docs/reference/platform/core/cisco_iosxe/patterns.md new file mode 100644 index 0000000..b9c1145 --- /dev/null +++ b/docs/reference/platform/core/cisco_iosxe/patterns.md @@ -0,0 +1 @@ +::: platform.core.cisco_iosxe.patterns \ No newline at end of file diff --git a/docs/reference/platform/core/cisco_iosxe/sync_platform.md b/docs/reference/platform/core/cisco_iosxe/sync_platform.md new file mode 100644 index 0000000..74ada24 --- /dev/null +++ b/docs/reference/platform/core/cisco_iosxe/sync_platform.md @@ -0,0 +1 @@ +::: platform.core.cisco_iosxe.sync_platform \ No newline at end of file diff --git a/docs/reference/platform/core/cisco_iosxr/async_platform.md b/docs/reference/platform/core/cisco_iosxr/async_platform.md new file mode 100644 index 0000000..1a50eb7 --- /dev/null +++ b/docs/reference/platform/core/cisco_iosxr/async_platform.md @@ -0,0 +1 @@ +::: platform.core.cisco_iosxr.async_platform \ No newline at end of file diff --git a/docs/reference/platform/core/cisco_iosxr/base_platform.md b/docs/reference/platform/core/cisco_iosxr/base_platform.md new file mode 100644 index 0000000..c36132f --- /dev/null +++ b/docs/reference/platform/core/cisco_iosxr/base_platform.md @@ -0,0 +1 @@ +::: platform.core.cisco_iosxr.base_platform \ No newline at end of file diff --git a/docs/reference/platform/core/cisco_iosxr/index.md b/docs/reference/platform/core/cisco_iosxr/index.md new file mode 100644 index 0000000..03327d9 --- /dev/null +++ b/docs/reference/platform/core/cisco_iosxr/index.md @@ -0,0 +1 @@ +::: platform.core.cisco_iosxr \ No newline at end of file diff --git a/docs/reference/platform/core/cisco_iosxr/patterns.md b/docs/reference/platform/core/cisco_iosxr/patterns.md new file mode 100644 index 0000000..24e8d60 --- /dev/null +++ b/docs/reference/platform/core/cisco_iosxr/patterns.md @@ -0,0 +1 @@ +::: platform.core.cisco_iosxr.patterns \ No newline at end of file diff --git a/docs/reference/platform/core/cisco_iosxr/sync_platform.md b/docs/reference/platform/core/cisco_iosxr/sync_platform.md new file mode 100644 index 0000000..02fddca --- /dev/null +++ b/docs/reference/platform/core/cisco_iosxr/sync_platform.md @@ -0,0 +1 @@ +::: platform.core.cisco_iosxr.sync_platform \ No newline at end of file diff --git a/docs/reference/platform/core/cisco_nxos/async_platform.md b/docs/reference/platform/core/cisco_nxos/async_platform.md new file mode 100644 index 0000000..8b55c6e --- /dev/null +++ b/docs/reference/platform/core/cisco_nxos/async_platform.md @@ -0,0 +1 @@ +::: platform.core.cisco_nxos.async_platform \ No newline at end of file diff --git a/docs/reference/platform/core/cisco_nxos/base_platform.md b/docs/reference/platform/core/cisco_nxos/base_platform.md new file mode 100644 index 0000000..79a8cc4 --- /dev/null +++ b/docs/reference/platform/core/cisco_nxos/base_platform.md @@ -0,0 +1 @@ +::: platform.core.cisco_nxos.base_platform \ No newline at end of file diff --git a/docs/reference/platform/core/cisco_nxos/index.md b/docs/reference/platform/core/cisco_nxos/index.md new file mode 100644 index 0000000..c9d2995 --- /dev/null +++ b/docs/reference/platform/core/cisco_nxos/index.md @@ -0,0 +1 @@ +::: platform.core.cisco_nxos \ No newline at end of file diff --git a/docs/reference/platform/core/cisco_nxos/patterns.md b/docs/reference/platform/core/cisco_nxos/patterns.md new file mode 100644 index 0000000..6d65c64 --- /dev/null +++ b/docs/reference/platform/core/cisco_nxos/patterns.md @@ -0,0 +1 @@ +::: platform.core.cisco_nxos.patterns \ No newline at end of file diff --git a/docs/reference/platform/core/cisco_nxos/sync_platform.md b/docs/reference/platform/core/cisco_nxos/sync_platform.md new file mode 100644 index 0000000..b064859 --- /dev/null +++ b/docs/reference/platform/core/cisco_nxos/sync_platform.md @@ -0,0 +1 @@ +::: platform.core.cisco_nxos.sync_platform \ No newline at end of file diff --git a/docs/reference/platform/core/index.md b/docs/reference/platform/core/index.md new file mode 100644 index 0000000..0ffae02 --- /dev/null +++ b/docs/reference/platform/core/index.md @@ -0,0 +1 @@ +::: platform.core \ No newline at end of file diff --git a/docs/reference/platform/core/juniper_junos/async_platform.md b/docs/reference/platform/core/juniper_junos/async_platform.md new file mode 100644 index 0000000..09aa032 --- /dev/null +++ b/docs/reference/platform/core/juniper_junos/async_platform.md @@ -0,0 +1 @@ +::: platform.core.juniper_junos.async_platform \ No newline at end of file diff --git a/docs/reference/platform/core/juniper_junos/base_platform.md b/docs/reference/platform/core/juniper_junos/base_platform.md new file mode 100644 index 0000000..9b59f68 --- /dev/null +++ b/docs/reference/platform/core/juniper_junos/base_platform.md @@ -0,0 +1 @@ +::: platform.core.juniper_junos.base_platform \ No newline at end of file diff --git a/docs/reference/platform/core/juniper_junos/index.md b/docs/reference/platform/core/juniper_junos/index.md new file mode 100644 index 0000000..2bb8c7e --- /dev/null +++ b/docs/reference/platform/core/juniper_junos/index.md @@ -0,0 +1 @@ +::: platform.core.juniper_junos \ No newline at end of file diff --git a/docs/reference/platform/core/juniper_junos/patterns.md b/docs/reference/platform/core/juniper_junos/patterns.md new file mode 100644 index 0000000..6f61603 --- /dev/null +++ b/docs/reference/platform/core/juniper_junos/patterns.md @@ -0,0 +1 @@ +::: platform.core.juniper_junos.patterns \ No newline at end of file diff --git a/docs/reference/platform/core/juniper_junos/sync_platform.md b/docs/reference/platform/core/juniper_junos/sync_platform.md new file mode 100644 index 0000000..ae62262 --- /dev/null +++ b/docs/reference/platform/core/juniper_junos/sync_platform.md @@ -0,0 +1 @@ +::: platform.core.juniper_junos.sync_platform \ No newline at end of file diff --git a/docs/reference/platform/index.md b/docs/reference/platform/index.md new file mode 100644 index 0000000..7e17d45 --- /dev/null +++ b/docs/reference/platform/index.md @@ -0,0 +1 @@ +::: platform \ No newline at end of file diff --git a/docs/reference/response.md b/docs/reference/response.md new file mode 100644 index 0000000..700901b --- /dev/null +++ b/docs/reference/response.md @@ -0,0 +1 @@ +::: response \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index 31b959e..bf7a724 100644 --- 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 index 0c48602..3f3aa84 100644 --- 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 \ No newline at end of file diff --git a/scrapli_cfg/__init__.py b/scrapli_cfg/__init__.py index a280008..2cc46a9 100644 --- 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",