diff options
| -rw-r--r-- | .github/workflows/python-app.yml | 14 | ||||
| -rw-r--r-- | .github/workflows/python-publish.yml | 8 | ||||
| -rw-r--r-- | README.md | 14 | ||||
| -rw-r--r-- | pyproject.toml | 12 | ||||
| -rw-r--r-- | requirements.txt | 4 |
5 files changed, 26 insertions, 26 deletions
diff --git a/.github/workflows/python-app.yml b/.github/workflows/python-app.yml index f3d4fca..96d39fa 100644 --- a/.github/workflows/python-app.yml +++ b/.github/workflows/python-app.yml @@ -18,11 +18,11 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 - - name: Set up Python 3.10 - uses: actions/setup-python@v3 + - uses: actions/checkout@v4.1.1 + - name: Set up Python 3.12.2 + uses: actions/setup-python@v5.0.0 with: - python-version: "3.10" + python-version: "3.12.2" - name: Install dependencies run: | python -m pip install --upgrade pip @@ -34,6 +34,6 @@ jobs: flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics - - name: Test with pytest - run: | - pytest + #- name: Test with pytest + # run: | + # pytest diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml index bdaab28..a5d4550 100644 --- a/.github/workflows/python-publish.yml +++ b/.github/workflows/python-publish.yml @@ -21,11 +21,11 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3 + - uses: actions/checkout@v4.1.1 - name: Set up Python - uses: actions/setup-python@v3 + uses: actions/setup-python@v5.0.0 with: - python-version: '3.x' + python-version: "3.12.2" - name: Install dependencies run: | python -m pip install --upgrade pip @@ -33,7 +33,7 @@ jobs: - name: Build package run: python -m build - name: Publish package - uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29 + uses: pypa/gh-action-pypi-publish@v1.8.14 with: user: __token__ password: ${{ secrets.PYPI_API_TOKEN }} @@ -1,12 +1,12 @@ -# PyVyOS Documentation +# pyvyos Documentation -PyVyOS is a Python library for interacting with VyOS devices via their API. This documentation provides a guide on how to use PyVyOS to manage your VyOS devices programmatically. +pyvyos is a Python library for interacting with VyOS devices via their API. This documentation provides a guide on how to use pyvyos to manage your VyOS devices programmatically. -You can find the complete PyVyOS documentation on [Read the Docs](https://pyvyos.readthedocs.io/en/latest/). +You can find the complete pyvyos documentation on [Read the Docs](https://pyvyos.readthedocs.io/en/latest/). ## Installation -You can install PyVyOS using pip: +You can install pyvyos using pip: ```bash pip install pyvyos @@ -15,7 +15,7 @@ pip install pyvyos ## Getting Started ### Importing and Disabling Warnings for verify=False -Before using PyVyOS, it's a good practice to disable urllib3 warnings and import the required modules, IF you use verify=False: +Before using pyvyos, it's a good practice to disable urllib3 warnings and import the required modules, IF you use verify=False: ``` import urllib3 @@ -23,7 +23,7 @@ urllib3.disable_warnings() ``` ### Using API Response Class -PyVyOS uses a custom ApiResponse data class to handle API responses: +pyvyos uses a custom ApiResponse data class to handle API responses: ``` @dataclass @@ -65,7 +65,7 @@ verify = verify_ssl.lower() == "true" if verify_ssl else True device = VyDevice(hostname=hostname, apikey=apikey, port=port, protocol=protocol, verify=verify) ``` -## Using PyVyOS +## Using pyvyos ### configure, then set The configure_set method sets a VyOS configuration: diff --git a/pyproject.toml b/pyproject.toml index 68d80d5..11613a0 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -23,11 +23,11 @@ Issues = "https://github.com/gravscale/pyvyos/issues" [tool.hatch.metadata] dependencies = [ - "requests>=2.25.1,<3.0", - "python-dotenv>=1.0.0,<2.0" + "requests>=2.31.0,<3.0", + "python-dotenv>=1.0.0,<2.0" ] dev-dependencies = [ - "pytest>=6.2.2,<7.0" + "pytest>=6.2.2,<7.0" ] [tool.poetry] @@ -37,7 +37,7 @@ authors = ["Roberto Berto <463349+robertoberto@users.noreply.github.com>"] version = "0.2.0" [tool.poetry.dependencies] -python = ">=3.8" -requests = "^2.31.0" -python-dotenv = "^1.0.0" +python = ">=3.8" +requests = "^2.31.0" +python-dotenv = "^1.0.0" diff --git a/requirements.txt b/requirements.txt index 4bde791..523e2c2 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,2 @@ -requests>=2.31.0<3.0.0 -dotenv>=1.0.0<2.0.0 +requests>=2.25.1,<3.0 +python-dotenv>=1.0.0,<2.0 |