Script 'mail_helper' called by obssrc
Hello community,
here is the log from the commit of package python-pynetbox for openSUSE:Factory
checked in at 2024-01-08 23:44:56
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Comparing /work/SRC/openSUSE:Factory/python-pynetbox (Old)
and /work/SRC/openSUSE:Factory/.python-pynetbox.new.21961 (New)
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Package is "python-pynetbox"
Mon Jan 8 23:44:56 2024 rev:36 rq:1137455 version:7.3.3
Changes:
--------
--- /work/SRC/openSUSE:Factory/python-pynetbox/python-pynetbox.changes
2023-09-08 21:16:57.513510289 +0200
+++
/work/SRC/openSUSE:Factory/.python-pynetbox.new.21961/python-pynetbox.changes
2024-01-08 23:45:04.437901136 +0100
@@ -1,0 +2,9 @@
+Sun Jan 7 22:04:34 UTC 2024 - Dirk Müller <dmuel...@suse.com>
+
+- update to 7.3.3:
+ * fix pypi release
+- update to 7.3.0:
+ * Add support for NetBox v3.7 by @markkuleinio #596
+ * Updated test suite by @abhi1693
+
+-------------------------------------------------------------------
Old:
----
pynetbox-7.2.0.tar.gz
New:
----
pynetbox-7.3.3.tar.gz
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Other differences:
------------------
++++++ python-pynetbox.spec ++++++
--- /var/tmp/diff_new_pack.gvmvuv/_old 2024-01-08 23:45:05.313932988 +0100
+++ /var/tmp/diff_new_pack.gvmvuv/_new 2024-01-08 23:45:05.313932988 +0100
@@ -1,7 +1,7 @@
#
# spec file for package python-pynetbox
#
-# Copyright (c) 2023 SUSE LLC
+# Copyright (c) 2024 SUSE LLC
#
# All modifications and additions to the file contributed by third parties
# remain the property of their copyright owners, unless otherwise agreed
@@ -18,7 +18,7 @@
%define skip_python2 1
Name: python-pynetbox
-Version: 7.2.0
+Version: 7.3.3
Release: 0
Summary: NetBox API client library
License: Apache-2.0
++++++ pynetbox-7.2.0.tar.gz -> pynetbox-7.3.3.tar.gz ++++++
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/pynetbox-7.2.0/.github/workflows/publish.yml
new/pynetbox-7.3.3/.github/workflows/publish.yml
--- old/pynetbox-7.2.0/.github/workflows/publish.yml 2023-09-07
17:42:40.000000000 +0200
+++ new/pynetbox-7.3.3/.github/workflows/publish.yml 2024-01-06
00:18:34.000000000 +0100
@@ -1,11 +1,19 @@
-# This workflows will upload a Python Package using Twine when a release is
created
-# For more information see:
https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+# This workflow will upload a Python Package using Twine when a release is
created
+# For more information see:
https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
name: Upload Python Package
on:
release:
- types: [created]
+ types: [published]
+
+permissions:
+ contents: read
jobs:
deploy:
@@ -13,19 +21,19 @@
runs-on: ubuntu-latest
steps:
- - uses: actions/checkout@v2
+ - uses: actions/checkout@v3
- name: Set up Python
- uses: actions/setup-python@v2
+ uses: actions/setup-python@v3
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
- pip install setuptools wheel twine
- - name: Build and publish
- env:
- TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
- TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
- run: |
- python setup.py sdist bdist_wheel
- twine upload dist/*
+ pip install build
+ - name: Build package
+ run: python -m build
+ - name: Publish package
+ uses:
pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+ with:
+ user: __token__
+ password: ${{ secrets.PYPI_API_TOKEN }}
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/pynetbox-7.2.0/.github/workflows/py3.yml
new/pynetbox-7.3.3/.github/workflows/py3.yml
--- old/pynetbox-7.2.0/.github/workflows/py3.yml 2023-09-07
17:42:40.000000000 +0200
+++ new/pynetbox-7.3.3/.github/workflows/py3.yml 2024-01-06
00:18:34.000000000 +0100
@@ -13,13 +13,13 @@
strategy:
matrix:
python: ["3.8", "3.9", "3.10", "3.11"]
- netbox: ["3.3", "3.4", "3.5", "3.6"]
+ netbox: ["3.3", "3.4", "3.5", "3.6", "3.7"]
steps:
- - uses: actions/checkout@v2
+ - uses: actions/checkout@v4
- name: Setup Python
- uses: actions/setup-python@v2
+ uses: actions/setup-python@v4
with:
python-version: ${{ matrix.python }}
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/pynetbox-7.2.0/.readthedocs.yaml
new/pynetbox-7.3.3/.readthedocs.yaml
--- old/pynetbox-7.2.0/.readthedocs.yaml 1970-01-01 01:00:00.000000000
+0100
+++ new/pynetbox-7.3.3/.readthedocs.yaml 2024-01-06 00:18:34.000000000
+0100
@@ -0,0 +1,15 @@
+version: 2
+
+build:
+ os: ubuntu-22.04
+ tools:
+ python: "3.11"
+
+# Build from the docs/ directory with Sphinx
+sphinx:
+ configuration: docs/conf.py
+
+# Explicitly set the version of Python and its requirements
+python:
+ install:
+ - requirements: docs/requirements.txt
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/pynetbox-7.2.0/PKG-INFO new/pynetbox-7.3.3/PKG-INFO
--- old/pynetbox-7.2.0/PKG-INFO 2023-09-07 17:42:53.921281800 +0200
+++ new/pynetbox-7.3.3/PKG-INFO 2024-01-06 00:18:43.660953500 +0100
@@ -1,6 +1,6 @@
Metadata-Version: 2.1
Name: pynetbox
-Version: 7.2.0
+Version: 7.3.3
Summary: NetBox API client library
Home-page: https://github.com/netbox-community/pynetbox
Author: Zach Moody
@@ -14,4 +14,75 @@
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
+Description-Content-Type: text/markdown
License-File: LICENSE
+Requires-Dist: requests<3.0,>=2.20.0
+Requires-Dist: packaging<24.0
+
+# Pynetbox
+Python API client library for
[NetBox](https://github.com/netbox-community/netbox).
+
+> **Note:** Version 6.7 and later of the library only supports NetBox 3.3 and
above.
+
+## Installation
+
+To install run `pip install pynetbox`.
+
+Alternatively, you can clone the repo and run `python setup.py install`.
+
+
+## Quick Start
+
+The full pynetbox API is documented on [Read the
Docs](http://pynetbox.readthedocs.io/en/latest/), but the following should be
enough to get started using it.
+
+To begin, import pynetbox and instantiate the API.
+
+```
+import pynetbox
+nb = pynetbox.api(
+ 'http://localhost:8000',
+ token='d6f4e314a5b5fefd164995169f28ae32d987704f'
+)
+```
+
+The first argument the .api() method takes is the NetBox URL. There are a
handful of named arguments you can provide, but in most cases none are required
to simply pull data. In order to write, the `token` argument should to be
provided.
+
+
+## Queries
+
+The pynetbox API is setup so that NetBox's apps are attributes of the `.api()`
object, and in turn those apps have attribute representing each endpoint. Each
endpoint has a handful of methods available to carry out actions on the
endpoint. For example, in order to query all the objects in the `devices`
endpoint you would do the following:
+
+```
+>>> devices = nb.dcim.devices.all()
+>>> for device in devices:
+... print(device.name)
+...
+test1-leaf1
+test1-leaf2
+test1-leaf3
+>>>
+```
+
+Note that the all() and filter() methods are generators and return an object
that can be iterated over only once. If you are going to be iterating over it
repeatedly you need to either call the all() method again, or encapsulate the
results in a `list` object like this:
+```
+>>> devices = list(nb.dcim.devices.all())
+```
+
+### Threading
+
+pynetbox supports multithreaded calls for `.filter()` and `.all()` queries. It
is **highly recommended** you have `MAX_PAGE_SIZE` in your Netbox install set
to anything *except* `0` or `None`. The default value of `1000` is usually a
good value to use. To enable threading, add `threading=True` parameter to the
`.api`:
+
+```python
+nb = pynetbox.api(
+ 'http://localhost:8000',
+ threading=True,
+)
+```
+
+## Alternative Library
+
+> **Note:** For those interested in a different approach, there is an
alternative Python API client library available for NetBox called
[netbox-python](https://github.com/netbox-community/netbox-python). This
library provides a thin Python wrapper over the NetBox API.
+
+[netbox-python](https://github.com/netbox-community/netbox-python) offers a
minimalistic interface to interact with NetBox's API. While it may not provide
all the features available in pynetbox, it offers a lightweight and
straightforward option for interfacing with NetBox.
+
+To explore further details and access the documentation, please visit the
[netbox-python](https://github.com/netbox-community/netbox-python).
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/pynetbox-7.2.0/docs/Makefile
new/pynetbox-7.3.3/docs/Makefile
--- old/pynetbox-7.2.0/docs/Makefile 2023-09-07 17:42:40.000000000 +0200
+++ new/pynetbox-7.3.3/docs/Makefile 2024-01-06 00:18:34.000000000 +0100
@@ -1,10 +1,10 @@
# Minimal makefile for Sphinx documentation
#
-# You can set these variables from the command line.
-SPHINXOPTS =
-SPHINXBUILD = sphinx-build
-SPHINXPROJ = pynetbox
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS ?=
+SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build
@@ -17,4 +17,4 @@
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
- @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
\ No newline at end of file
+ @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/pynetbox-7.2.0/docs/conf.py
new/pynetbox-7.3.3/docs/conf.py
--- old/pynetbox-7.2.0/docs/conf.py 2023-09-07 17:42:40.000000000 +0200
+++ new/pynetbox-7.3.3/docs/conf.py 2024-01-06 00:18:34.000000000 +0100
@@ -1,157 +1,44 @@
-# -*- coding: utf-8 -*-
+# Configuration file for the Sphinx documentation builder.
#
-# pynetbox documentation build configuration file, created by
-# sphinx-quickstart on Thu Apr 6 22:31:03 2017.
-#
-# This file is execfile()d with the current directory set to its
-# containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-import os
-import sys
-from pkg_resources import get_distribution
+from importlib.metadata import version
-sys.path.insert(0, os.path.abspath("../"))
+# -- Project information -----------------------------------------------------
+#
https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+project = 'pynetbox'
+copyright = '2023, NetBox'
+author = 'Abhimanyu Saharan'
+release = 'Apache2'
-# -- General configuration ------------------------------------------------
+# -- General configuration ---------------------------------------------------
+#
https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
-# If your documentation needs a minimal Sphinx version, state it here.
-#
-# needs_sphinx = '1.0'
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
extensions = ["sphinx.ext.autodoc"]
-# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
-
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-#
-# source_suffix = ['.rst', '.md']
-source_suffix = ".rst"
+exclude_patterns = ["_build"]
# The master toctree document.
master_doc = "index"
-# General information about the project.
-project = "pynetbox"
-copyright = "2017, DigitalOcean"
-author = "Zach Moody"
+# -- Options for HTML output -------------------------------------------------
+#
https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-# The full version, including alpha/beta/rc tags.
-release = get_distribution("pynetbox").version
-#
-# The short X.Y version.
-version = ".".join(release.split(".")[:2])
+html_theme = "sphinx_rtd_theme"
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#
-# This is also used if you do content translation via gettext catalogs.
-# Usually you set "language" from the command line for these cases.
-language = None
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+htmlhelp_basename = "pynetboxdoc"
-# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"
-# If true, `todo` and `todoList` produce output, else they produce nothing.
-todo_include_todos = False
-
-
-# -- Options for HTML output ----------------------------------------------
-
-# The theme to use for HTML and HTML Help pages. See the documentation for
-# a list of builtin themes.
-#
-# html_theme = 'classic'
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+# The full version, including alpha/beta/rc tags.
+release_version = version("pynetbox")
-# Theme options are theme-specific and customize the look and feel of a theme
-# further. For a list of options available for each theme, see the
-# documentation.
#
-# html_theme_options = {}
-
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
-# html_static_path = ['_static']
-
-html_sidebars = {
- "**": ["globaltoc.html", "relations.html", "sourcelink.html",
"searchbox.html"]
-}
-
-# -- Options for HTMLHelp output ------------------------------------------
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = "pynetboxdoc"
-
-
-# -- Options for LaTeX output ---------------------------------------------
-
-latex_elements = {
- # The paper size ('letterpaper' or 'a4paper').
- #
- # 'papersize': 'letterpaper',
- # The font size ('10pt', '11pt' or '12pt').
- #
- # 'pointsize': '10pt',
- # Additional stuff for the LaTeX preamble.
- #
- # 'preamble': '',
- # Latex figure (float) alignment
- #
- # 'figure_align': 'htbp',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-# author, documentclass [howto, manual, or own class]).
-latex_documents = [
- (master_doc, "pynetbox.tex", "pynetbox Documentation", "Zach Moody",
"manual"),
-]
-
-
-# -- Options for manual page output ---------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [(master_doc, "pynetbox", "pynetbox Documentation", [author], 1)]
-
-
-# -- Options for Texinfo output -------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-# dir menu entry, description, category)
-texinfo_documents = [
- (
- master_doc,
- "pynetbox",
- "pynetbox Documentation",
- author,
- "pynetbox",
- "A python library for NetBox.",
- "Miscellaneous",
- ),
-]
+# The short X.Y version.
+version = ".".join(release_version.split(".")[:2])
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/pynetbox-7.2.0/docs/index.rst
new/pynetbox-7.3.3/docs/index.rst
--- old/pynetbox-7.2.0/docs/index.rst 2023-09-07 17:42:40.000000000 +0200
+++ new/pynetbox-7.3.3/docs/index.rst 2024-01-06 00:18:34.000000000 +0100
@@ -6,10 +6,11 @@
response
request
IPAM
+ advanced
TL;DR
=====
-Instantiate the :py:class:`.Api`. Use the methods available on
:py:class:`.Endpoint` to return :py:class:`.Record` objects.
+Instantiate the :py:class:`.Api`. Use the methods available on
:py:class:`.Endpoint` to return :py:class:`.Record` objects.
API
===
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/pynetbox-7.2.0/docs/requirements.txt
new/pynetbox-7.3.3/docs/requirements.txt
--- old/pynetbox-7.2.0/docs/requirements.txt 1970-01-01 01:00:00.000000000
+0100
+++ new/pynetbox-7.3.3/docs/requirements.txt 2024-01-06 00:18:34.000000000
+0100
@@ -0,0 +1,4 @@
+sphinx<8.0.0
+sphinx_rtd_theme<2.0.0
+readthedocs-sphinx-search<0.4.0
+pynetbox
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/pynetbox-7.2.0/pynetbox/__init__.py
new/pynetbox-7.3.3/pynetbox/__init__.py
--- old/pynetbox-7.2.0/pynetbox/__init__.py 2023-09-07 17:42:40.000000000
+0200
+++ new/pynetbox-7.3.3/pynetbox/__init__.py 2024-01-06 00:18:34.000000000
+0100
@@ -1,6 +1,6 @@
-from importlib.metadata import metadata
+from importlib.metadata import version
from pynetbox.core.query import RequestError, AllocationError, ContentError
from pynetbox.core.api import Api as api
-__version__ = metadata(__name__).get("Version")
+__version__ = version(__name__)
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/pynetbox-7.2.0/pynetbox/core/api.py
new/pynetbox-7.3.3/pynetbox/core/api.py
--- old/pynetbox-7.2.0/pynetbox/core/api.py 2023-09-07 17:42:40.000000000
+0200
+++ new/pynetbox-7.3.3/pynetbox/core/api.py 2024-01-06 00:18:34.000000000
+0100
@@ -27,14 +27,15 @@
you can specify which app and endpoint you wish to interact with.
Valid attributes currently are:
+ * circuits
* core (NetBox 3.5+)
* dcim
+ * extras
* ipam
- * circuits
* tenancy
- * extras
- * virtualization
* users
+ * virtualization
+ * vpn (NetBox 3.7+)
* wireless
Calling any of these attributes will return
@@ -75,14 +76,15 @@
self.base_url = base_url
self.http_session = requests.Session()
self.threading = threading
+ self.circuits = App(self, "circuits")
self.core = App(self, "core")
self.dcim = App(self, "dcim")
+ self.extras = App(self, "extras")
self.ipam = App(self, "ipam")
- self.circuits = App(self, "circuits")
self.tenancy = App(self, "tenancy")
- self.extras = App(self, "extras")
- self.virtualization = App(self, "virtualization")
self.users = App(self, "users")
+ self.virtualization = App(self, "virtualization")
+ self.vpn = App(self, "vpn")
self.wireless = App(self, "wireless")
self.plugins = PluginsApp(self)
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/pynetbox-7.2.0/pynetbox/models/dcim.py
new/pynetbox-7.3.3/pynetbox/models/dcim.py
--- old/pynetbox-7.2.0/pynetbox/models/dcim.py 2023-09-07 17:42:40.000000000
+0200
+++ new/pynetbox-7.3.3/pynetbox/models/dcim.py 2024-01-06 00:18:34.000000000
+0100
@@ -61,7 +61,7 @@
).get()
ret = []
- for (a_terminations_data, cable_data, b_terminations_data) in req:
+ for a_terminations_data, cable_data, b_terminations_data in req:
ret.append(self._build_termination_data(a_terminations_data))
if not cable_data:
ret.append(cable_data)
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/pynetbox-7.2.0/pynetbox/models/virtualization.py
new/pynetbox-7.3.3/pynetbox/models/virtualization.py
--- old/pynetbox-7.2.0/pynetbox/models/virtualization.py 2023-09-07
17:42:40.000000000 +0200
+++ new/pynetbox-7.3.3/pynetbox/models/virtualization.py 2024-01-06
00:18:34.000000000 +0100
@@ -18,7 +18,6 @@
class VirtualMachines(Record):
-
primary_ip = IpAddresses
primary_ip4 = IpAddresses
primary_ip6 = IpAddresses
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/pynetbox-7.2.0/pynetbox.egg-info/PKG-INFO
new/pynetbox-7.3.3/pynetbox.egg-info/PKG-INFO
--- old/pynetbox-7.2.0/pynetbox.egg-info/PKG-INFO 2023-09-07
17:42:53.000000000 +0200
+++ new/pynetbox-7.3.3/pynetbox.egg-info/PKG-INFO 2024-01-06
00:18:43.000000000 +0100
@@ -1,6 +1,6 @@
Metadata-Version: 2.1
Name: pynetbox
-Version: 7.2.0
+Version: 7.3.3
Summary: NetBox API client library
Home-page: https://github.com/netbox-community/pynetbox
Author: Zach Moody
@@ -14,4 +14,75 @@
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
+Description-Content-Type: text/markdown
License-File: LICENSE
+Requires-Dist: requests<3.0,>=2.20.0
+Requires-Dist: packaging<24.0
+
+# Pynetbox
+Python API client library for
[NetBox](https://github.com/netbox-community/netbox).
+
+> **Note:** Version 6.7 and later of the library only supports NetBox 3.3 and
above.
+
+## Installation
+
+To install run `pip install pynetbox`.
+
+Alternatively, you can clone the repo and run `python setup.py install`.
+
+
+## Quick Start
+
+The full pynetbox API is documented on [Read the
Docs](http://pynetbox.readthedocs.io/en/latest/), but the following should be
enough to get started using it.
+
+To begin, import pynetbox and instantiate the API.
+
+```
+import pynetbox
+nb = pynetbox.api(
+ 'http://localhost:8000',
+ token='d6f4e314a5b5fefd164995169f28ae32d987704f'
+)
+```
+
+The first argument the .api() method takes is the NetBox URL. There are a
handful of named arguments you can provide, but in most cases none are required
to simply pull data. In order to write, the `token` argument should to be
provided.
+
+
+## Queries
+
+The pynetbox API is setup so that NetBox's apps are attributes of the `.api()`
object, and in turn those apps have attribute representing each endpoint. Each
endpoint has a handful of methods available to carry out actions on the
endpoint. For example, in order to query all the objects in the `devices`
endpoint you would do the following:
+
+```
+>>> devices = nb.dcim.devices.all()
+>>> for device in devices:
+... print(device.name)
+...
+test1-leaf1
+test1-leaf2
+test1-leaf3
+>>>
+```
+
+Note that the all() and filter() methods are generators and return an object
that can be iterated over only once. If you are going to be iterating over it
repeatedly you need to either call the all() method again, or encapsulate the
results in a `list` object like this:
+```
+>>> devices = list(nb.dcim.devices.all())
+```
+
+### Threading
+
+pynetbox supports multithreaded calls for `.filter()` and `.all()` queries. It
is **highly recommended** you have `MAX_PAGE_SIZE` in your Netbox install set
to anything *except* `0` or `None`. The default value of `1000` is usually a
good value to use. To enable threading, add `threading=True` parameter to the
`.api`:
+
+```python
+nb = pynetbox.api(
+ 'http://localhost:8000',
+ threading=True,
+)
+```
+
+## Alternative Library
+
+> **Note:** For those interested in a different approach, there is an
alternative Python API client library available for NetBox called
[netbox-python](https://github.com/netbox-community/netbox-python). This
library provides a thin Python wrapper over the NetBox API.
+
+[netbox-python](https://github.com/netbox-community/netbox-python) offers a
minimalistic interface to interact with NetBox's API. While it may not provide
all the features available in pynetbox, it offers a lightweight and
straightforward option for interfacing with NetBox.
+
+To explore further details and access the documentation, please visit the
[netbox-python](https://github.com/netbox-community/netbox-python).
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/pynetbox-7.2.0/pynetbox.egg-info/SOURCES.txt
new/pynetbox-7.3.3/pynetbox.egg-info/SOURCES.txt
--- old/pynetbox-7.2.0/pynetbox.egg-info/SOURCES.txt 2023-09-07
17:42:53.000000000 +0200
+++ new/pynetbox-7.3.3/pynetbox.egg-info/SOURCES.txt 2024-01-06
00:18:43.000000000 +0100
@@ -1,4 +1,5 @@
.gitignore
+.readthedocs.yaml
CHANGELOG.md
LICENSE
README.md
@@ -21,6 +22,7 @@
docs/endpoint.rst
docs/index.rst
docs/request.rst
+docs/requirements.txt
docs/response.rst
pynetbox/__init__.py
pynetbox.egg-info/PKG-INFO
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/pynetbox-7.2.0/requirements-dev.txt
new/pynetbox-7.3.3/requirements-dev.txt
--- old/pynetbox-7.2.0/requirements-dev.txt 2023-09-07 17:42:40.000000000
+0200
+++ new/pynetbox-7.3.3/requirements-dev.txt 2024-01-06 00:18:34.000000000
+0100
@@ -1,4 +1,4 @@
-black~=22.10
-pytest==7.1.*
-pytest-docker==1.0.*
-PyYAML==6.0.1
+black
+pytest
+pytest-docker
+PyYAML
\ No newline at end of file
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/pynetbox-7.2.0/setup.py new/pynetbox-7.3.3/setup.py
--- old/pynetbox-7.2.0/setup.py 2023-09-07 17:42:40.000000000 +0200
+++ new/pynetbox-7.3.3/setup.py 2024-01-06 00:18:34.000000000 +0100
@@ -11,6 +11,8 @@
use_scm_version=True,
setup_requires=["setuptools_scm"],
packages=find_packages(exclude=["tests", "tests.*"]),
+ long_description=open('README.md').read(),
+ long_description_content_type='text/markdown',
install_requires=[
"requests>=2.20.0,<3.0",
"packaging<24.0"
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/pynetbox-7.2.0/tests/conftest.py
new/pynetbox-7.3.3/tests/conftest.py
--- old/pynetbox-7.2.0/tests/conftest.py 2023-09-07 17:42:40.000000000
+0200
+++ new/pynetbox-7.3.3/tests/conftest.py 2024-01-06 00:18:34.000000000
+0100
@@ -4,7 +4,7 @@
from packaging import version
-DEFAULT_NETBOX_VERSIONS = "3.6"
+DEFAULT_NETBOX_VERSIONS = "3.7"
def pytest_addoption(parser):
@@ -55,7 +55,6 @@
for version_string in config.option.netbox_versions.split(",")
]
if "no:docker" in config.option.plugins and config.option.url_override:
-
url_parse = parse.urlparse(config.option.url_override)
class DockerServicesMock:
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/pynetbox-7.2.0/tests/integration/conftest.py
new/pynetbox-7.3.3/tests/integration/conftest.py
--- old/pynetbox-7.2.0/tests/integration/conftest.py 2023-09-07
17:42:40.000000000 +0200
+++ new/pynetbox-7.3.3/tests/integration/conftest.py 2024-01-06
00:18:34.000000000 +0100
@@ -35,6 +35,8 @@
tag = "2.6.1"
elif (major, minor) == (3, 6):
tag = "2.7.0"
+ elif (major, minor) == (3, 7):
+ tag = "2.8.0"
else:
raise NotImplementedError(
"Version %s is not currently supported" % netbox_version
diff -urN '--exclude=CVS' '--exclude=.cvsignore' '--exclude=.svn'
'--exclude=.svnignore' old/pynetbox-7.2.0/tests/unit/test_endpoint.py
new/pynetbox-7.3.3/tests/unit/test_endpoint.py
--- old/pynetbox-7.2.0/tests/unit/test_endpoint.py 2023-09-07
17:42:40.000000000 +0200
+++ new/pynetbox-7.3.3/tests/unit/test_endpoint.py 2024-01-06
00:18:34.000000000 +0100
@@ -17,7 +17,6 @@
self.assertEqual(len(test), 2)
def test_filter_invalid_pagination_args(self):
-
api = Mock(base_url="http://localhost:8000/api";)
app = Mock(name="test")
test_obj = Endpoint(api, app, "test")
@@ -25,7 +24,6 @@
test_obj.filter(offset=1)
def test_all_invalid_pagination_args(self):
-
api = Mock(base_url="http://localhost:8000/api";)
app = Mock(name="test")
test_obj = Endpoint(api, app, "test")
