diff --git a/.github/workflows/azure-static-web-apps-gentle-meadow-01f9c9a0f.yml b/.github/workflows/azure-static-web-apps-gentle-meadow-01f9c9a0f.yml index 94c733796..2d25baed7 100644 --- a/.github/workflows/azure-static-web-apps-gentle-meadow-01f9c9a0f.yml +++ b/.github/workflows/azure-static-web-apps-gentle-meadow-01f9c9a0f.yml @@ -30,11 +30,11 @@ jobs: - name: Set up Sphinx uses: BSFishy/pip-action@v1 with: - packages: sphinx sphinx-autobuild sphinx_rtd_theme + packages: poetry # Build the docs - name: Build the docs - run: cd docs && make html + run: poetry install && cd docs && poetry run make html - name: Build And Deploy id: builddeploy diff --git a/CHANGES.txt b/CHANGES.txt index 50442d194..ff7a44adb 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -1,3 +1,9 @@ +Revision 6.0.0, released 2023-10-21 +----------------------------------- + +- Python 12 only test release. +- Removed all legacy code so that the API surface is smaller and your code might break. + Revision 5.0.29, released 2023-09-12 ------------------------------------ diff --git a/docs/source/docs/api-reference.rst b/docs/source/docs/api-reference.rst index c7d0c50fd..7af1c9206 100644 --- a/docs/source/docs/api-reference.rst +++ b/docs/source/docs/api-reference.rst @@ -15,50 +15,9 @@ right into your Python interactive session. Most of SNMP operations involve packet exchange over network. PySNMP is shipped with a set of bindings to popular asynchronous Python I/O -frameworks that let you run PySNMP in parallel with other tasks your +framework that let you run PySNMP in parallel with other tasks your application may perform. -Synchronous SNMP ----------------- - -Most simple and straightforward way to use PySNMP is by employing its -Synchronous, blocking API. It's also the default API offered by -users on *pysnmp.hlapi* sub-package import. - -Command Generator - -.. toctree:: - :maxdepth: 2 - - /docs/hlapi/asyncio/manager/cmdgen/getcmd - /docs/hlapi/asyncio/manager/cmdgen/setcmd - /docs/hlapi/asyncio/manager/cmdgen/nextcmd - /docs/hlapi/asyncio/manager/cmdgen/bulkcmd - -Notification Originator - -.. toctree:: - :maxdepth: 2 - - /docs/hlapi/asyncio/agent/ntforg/notification - -Transport configuration -+++++++++++++++++++++++ - -The following shortcut classes convey configuration information to -SNMP engine's Local Configuration Datastore (:RFC:`2271#section-3.4.2`) -as well as to underlying socket API. Once committed to LCD, SNMP engine -saves its configuration for the lifetime of SNMP engine object. - -.. toctree:: - :maxdepth: 2 - -.. autoclass:: pysnmp.hlapi.UdpTransportTarget - :members: setLocalAddress - -.. autoclass:: pysnmp.hlapi.Udp6TransportTarget - :members: setLocalAddress - Asynchronous: asyncio --------------------- diff --git a/docs/source/examples/hlapi/asyncio/manager/cmdgen/mib-tweaks.rst b/docs/source/examples/hlapi/asyncio/manager/cmdgen/mib-tweaks.rst index 99a62c7ed..2c9f2e9bc 100644 --- a/docs/source/examples/hlapi/asyncio/manager/cmdgen/mib-tweaks.rst +++ b/docs/source/examples/hlapi/asyncio/manager/cmdgen/mib-tweaks.rst @@ -4,45 +4,45 @@ MIB tweaks ---------- -.. include:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/waive-mib-lookup.py - :start-after: """ - :end-before: """# +.. .. include:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/waive-mib-lookup.py +.. :start-after: """ +.. :end-before: """# -.. literalinclude:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/waive-mib-lookup.py - :start-after: """# - :language: python +.. .. literalinclude:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/waive-mib-lookup.py +.. :start-after: """# +.. :language: python -:download:`Download` script. +.. :download:`Download` script. -.. include:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/preload-pysnmp-mibs.py - :start-after: """ - :end-before: """# +.. .. include:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/preload-pysnmp-mibs.py +.. :start-after: """ +.. :end-before: """# -.. literalinclude:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/preload-pysnmp-mibs.py - :start-after: """# - :language: python +.. .. literalinclude:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/preload-pysnmp-mibs.py +.. :start-after: """# +.. :language: python -:download:`Download` script. +.. :download:`Download` script. -.. include:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/custom-asn1-mib-search-path.py - :start-after: """ - :end-before: """# +.. .. include:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/custom-asn1-mib-search-path.py +.. :start-after: """ +.. :end-before: """# -.. literalinclude:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/custom-asn1-mib-search-path.py - :start-after: """# - :language: python +.. .. literalinclude:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/custom-asn1-mib-search-path.py +.. :start-after: """# +.. :language: python -:download:`Download` script. +.. :download:`Download` script. -.. include:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/custom-pysnmp-mibs-search-path.py - :start-after: """ - :end-before: """# +.. .. include:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/custom-pysnmp-mibs-search-path.py +.. :start-after: """ +.. :end-before: """# -.. literalinclude:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/custom-pysnmp-mibs-search-path.py - :start-after: """# - :language: python +.. .. literalinclude:: /../../examples/hlapi/v3arch/asyncio/manager/cmdgen/custom-pysnmp-mibs-search-path.py +.. :start-after: """# +.. :language: python -:download:`Download` script. +.. :download:`Download` script. See also: :doc:`library reference `. diff --git a/docs/source/examples/index.rst b/docs/source/examples/index.rst index 217c61d9a..7c4cc5fe4 100644 --- a/docs/source/examples/index.rst +++ b/docs/source/examples/index.rst @@ -66,33 +66,33 @@ message and transport levels. Command Generator +++++++++++++++++ -.. toctree:: +.. .. toctree:: - /examples/v1arch/asyncio/manager/cmdgen/fetching-variables - /examples/v1arch/asyncio/manager/cmdgen/modifying-variables - /examples/v1arch/asyncio/manager/cmdgen/walking-operations - /examples/v1arch/asyncio/manager/cmdgen/transport-tweaks + .. /examples/v1arch/asyncio/manager/cmdgen/fetching-variables + .. /examples/v1arch/asyncio/manager/cmdgen/modifying-variables + .. /examples/v1arch/asyncio/manager/cmdgen/walking-operations + .. /examples/v1arch/asyncio/manager/cmdgen/transport-tweaks Command Responder +++++++++++++++++ -.. toctree:: +.. .. toctree:: - /examples/v1arch/asyncio/agent/cmdrsp/agent-side-mib-implementations + .. /examples/v1arch/asyncio/agent/cmdrsp/agent-side-mib-implementations Notification Originator +++++++++++++++++++++++ -.. toctree:: +.. .. toctree:: - /examples/v1arch/asyncio/agent/ntforg/transport-tweaks + .. /examples/v1arch/asyncio/agent/ntforg/transport-tweaks Notification Receiver +++++++++++++++++++++ -.. toctree:: +.. .. toctree:: - /examples/v1arch/asyncio/manager/ntfrcv/transport-tweaks + .. /examples/v1arch/asyncio/manager/ntfrcv/transport-tweaks Low-level MIB access --------------------