Finishes Code References

nautobot · Apr 27, 2024 · bd39067 · bd39067
1 parent df8fea6
commit bd39067
Show file tree

Hide file tree

Showing 46 changed files with 244 additions and 92 deletions.
diff --git a/docs/api/core/api.md b/docs/api/core/api.md
diff --git a/docs/api/core/app.md b/docs/api/core/app.md
diff --git a/docs/api/core/endpoint.md b/docs/api/core/endpoint.md
diff --git a/docs/api/core/index.md b/docs/api/core/index.md
diff --git a/docs/api/core/query.md b/docs/api/core/query.md
diff --git a/docs/api/core/response.md b/docs/api/core/response.md
diff --git a/docs/api/core/util.md b/docs/api/core/util.md
diff --git a/docs/api/index.md b/docs/api/index.md
diff --git a/docs/api/models/circuits.md b/docs/api/models/circuits.md
diff --git a/docs/api/models/dcim.md b/docs/api/models/dcim.md
diff --git a/docs/api/models/extras.md b/docs/api/models/extras.md
diff --git a/docs/api/models/index.md b/docs/api/models/index.md
diff --git a/docs/api/models/ipam.md b/docs/api/models/ipam.md
diff --git a/docs/api/models/virtualization.md b/docs/api/models/virtualization.md
diff --git a/docs/basic/index.md b/docs/basic/index.md
diff --git a/docs/advanced/create.md → docs/dev/advanced/create.md b/docs/advanced/create.md → docs/dev/advanced/create.md
diff --git a/docs/advanced/delete.md → docs/dev/advanced/delete.md b/docs/advanced/delete.md → docs/dev/advanced/delete.md
diff --git a/docs/advanced/graphql.md → docs/dev/advanced/graphql.md b/docs/advanced/graphql.md → docs/dev/advanced/graphql.md
diff --git a/docs/advanced/index.md → docs/dev/advanced/index.md b/docs/advanced/index.md → docs/dev/advanced/index.md
diff --git a/docs/advanced/read.md → docs/dev/advanced/read.md b/docs/advanced/read.md → docs/dev/advanced/read.md
diff --git a/docs/advanced/record.md → docs/dev/advanced/record.md b/docs/advanced/record.md → docs/dev/advanced/record.md
diff --git a/docs/advanced/session.md → docs/dev/advanced/session.md b/docs/advanced/session.md → docs/dev/advanced/session.md
diff --git a/docs/advanced/update.md → docs/dev/advanced/update.md b/docs/advanced/update.md → docs/dev/advanced/update.md
diff --git a/docs/basic/api.md → docs/dev/basic/api.md b/docs/basic/api.md → docs/dev/basic/api.md
diff --git a/docs/basic/crud/create.md → docs/dev/basic/crud/create.md b/docs/basic/crud/create.md → docs/dev/basic/crud/create.md
diff --git a/docs/basic/crud/delete.md → docs/dev/basic/crud/delete.md b/docs/basic/crud/delete.md → docs/dev/basic/crud/delete.md
diff --git a/docs/basic/crud/index.md → docs/dev/basic/crud/index.md b/docs/basic/crud/index.md → docs/dev/basic/crud/index.md
diff --git a/docs/basic/crud/read.md → docs/dev/basic/crud/read.md b/docs/basic/crud/read.md → docs/dev/basic/crud/read.md
diff --git a/docs/basic/crud/update.md → docs/dev/basic/crud/update.md b/docs/basic/crud/update.md → docs/dev/basic/crud/update.md
diff --git a/docs/dev/basic/index.md b/docs/dev/basic/index.md
@@ -0,0 +1,21 @@
+# Quickstart Guide
+
+The pynautobot package is a Python SDK for retrieving and managing data in Nautobot. The following demonstrates how to connect to and interact with the Nautobot REST API.
+
+## Terminology
+
+**Apps:** The root level interfaces in Nautobot (IPAM, DCIM, etc.). Apps
+are represented by the `pynautobot.core.app.App` class.
+
+**Models:** The second level interfaces in Nautobot (IP Addresses Devices, etc.). Models correspond to tables in the Nautobot database, are represented by the `pynautobot.core.endpoint.Endpoint` class.
+
+**Endpoint:** The class that represents Models.
+
+**Records:** The rows associated with a Model\'s database table. Records hold the data stored in Nautobot. Records are represented by the `pynautobot.core.response.Record` class.
+
+**Entries:** See Records.
+
+**Fields:** The column names associated with a Model's database table. `pynautobot.core.endpoint.Endpoint` objects use these as keyword arguments for some methods objects use these as attribute names.
+
+**Plugins:** Additional [Apps]{.title-ref} added added to the Nautobot deployment that are external to provided Nautobot package.
+
diff --git a/docs/dev/basic/nautobot_apps.md b/docs/dev/basic/nautobot_apps.md
@@ -0,0 +1,97 @@
+# Accessing Nautobot Apps
+
+Nautobot allows for the expansion of the core application with the support of additional applications to be installed on top of Nautobot. To that, the SDK should support this capability. A couple of examples include accessing job results or the applications.
+
+=== "Accessing Job Results"
+
+    ```python
+    In [1]: import pynautobot
+
+    In [2]: nautobot = pynautobot.api("https://demo.nautobot.com", token=nautobot_api_token)
+
+    In [3]: jobs_results = getattr(nautobot.extras, "job-results")
+
+    In [4]: jobs_results
+    Out[4]: <pynautobot.core.endpoint.Endpoint at 0x1047929a0>
+
+    In [5]: jobs_results.all()
+    Out[5]:
+    [plugins/nautobot_golden_config.jobs/AllGoldenConfig,
+    plugins/nautobot_golden_config.jobs/AllGoldenConfig,
+    DeviceConnectionsReport,
+    VerifyPrimaryIP,
+    VerifyPlatform,
+    VerifyHostnames,
+    VerifyHasRack,
+    VerifyCircuitTermination,
+    device lifecycle,
+    device lifecycle,
+    templates,
+    templates,
+    data,
+    data,
+    configs,
+    configs,
+    backups,
+    backups,
+    colo,
+    colo,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    pops,
+    devicetypes,
+    devicetypes,
+    circuits,
+    manufacturers,
+    regions,
+    users]
+    ```
+
+=== "Access Application Endpoints"
+
+    This demonstrates accessing the Device Lifecycle Management endpoints.
+
+    ```
+    import pynautobot
+
+    nautobot = pynautobot.api(
+        url="http://localhost:8000",
+        token="d6f4e314a5b5fefd164995169f28ae32d987704f",
+    )
+
+    test = getattr(nautobot.plugins, "nautobot-device-lifecycle-mgmt")
+
+    cves = test.cve.all()
+    ```
diff --git a/docs/dev/code_reference/core/api.md b/docs/dev/code_reference/core/api.md
@@ -0,0 +1,5 @@
+# API
+
+::: pynautobot.core.api
+    options:
+        show_submodules: true
diff --git a/docs/dev/code_reference/core/app.md b/docs/dev/code_reference/core/app.md
@@ -0,0 +1,5 @@
+# App
+
+::: pynautobot.core.app
+    options:
+        show_submodules: true
diff --git a/docs/dev/code_reference/core/endpoint.md b/docs/dev/code_reference/core/endpoint.md
@@ -0,0 +1,5 @@
+# Endpoint
+
+::: pynautobot.core.endpoint
+    options:
+        show_submodules: true
diff --git a/docs/dev/code_reference/core/graphql.md b/docs/dev/code_reference/core/graphql.md
@@ -0,0 +1,5 @@
+# GraphQL
+
+::: pynautobot.core.graphql
+    options:
+        show_submodules: true
diff --git a/docs/dev/code_reference/core/query.md b/docs/dev/code_reference/core/query.md
@@ -0,0 +1,5 @@
+# Query
+
+::: pynautobot.core.query
+    options:
+        show_submodules: true
diff --git a/docs/dev/code_reference/core/response.md b/docs/dev/code_reference/core/response.md
@@ -0,0 +1,5 @@
+# Response
+
+::: pynautobot.core.response
+    options:
+        show_submodules: true
diff --git a/docs/dev/code_reference/core/util.md b/docs/dev/code_reference/core/util.md
@@ -0,0 +1,5 @@
+# Util
+
+::: pynautobot.core.util
+    options:
+        show_submodules: true
diff --git a/docs/dev/code_reference/models/circuits.md b/docs/dev/code_reference/models/circuits.md
@@ -0,0 +1,5 @@
+# Circuits
+
+::: pynautobot.models.circuits
+    options:
+        show_submodules: true
diff --git a/docs/dev/code_reference/models/dcim.md b/docs/dev/code_reference/models/dcim.md
@@ -0,0 +1,5 @@
+# DCIM
+
+::: pynautobot.models.dcim
+    options:
+        show_submodules: true
diff --git a/docs/dev/code_reference/models/extras.md b/docs/dev/code_reference/models/extras.md
@@ -0,0 +1,5 @@
+# Extras
+
+::: pynautobot.models.extras
+    options:
+        show_submodules: true
diff --git a/docs/dev/code_reference/models/ipam.md b/docs/dev/code_reference/models/ipam.md
@@ -0,0 +1,5 @@
+# IPAM
+
+::: pynautobot.models.ipam
+    options:
+        show_submodules: true
diff --git a/docs/dev/code_reference/models/users.md b/docs/dev/code_reference/models/users.md
@@ -0,0 +1,5 @@
+# Users
+
+::: pynautobot.models.users
+    options:
+        show_submodules: true
diff --git a/docs/dev/code_reference/models/virtualization.md b/docs/dev/code_reference/models/virtualization.md
@@ -0,0 +1,5 @@
+# Virtualization
+
+::: pynautobot.models.virtualization
+    options:
+        show_submodules: true
diff --git a/docs/user/lib_overview.md b/docs/user/lib_overview.md
@@ -0,0 +1,23 @@
+# Library Overview
+
+A Python library for interacting with the Nautobot API. 
+
+## Description/Overview
+
+This library dynamically generates objects from the Nautobot API. When a new API endpoint is created by the Nautobot application no significant updates are expected by the pynautobot library.
+
+This library is used heavily by the [Nautobot-Ansible](https://github.com/nautobot/nautobot-ansible) modules. 
+
+
+## Audience (User Personas) - Who should use this Library?
+
+**Python Developers**
+Python developers that are looking to interact with Nautobot in an object orientated fashion. 
+
+**Network Automators**
+Those that are involved with network automation using Python or Ansible. Ansible users will want to be familiar with the library.
+
+## Authors and Maintainers
+
+- @jvanderaa
+- @joewesch
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -100,6 +100,8 @@ markdown_extensions:
 
 nav:
   - Overview: "index.md"
+  - User Guide:
+      - Library Overview: "user/lib_overview.md"
   - Adminsitrator Guide:
       - Install and Configure: "admin/install.md"
       - Upgrade: "admin/upgrade.md"
@@ -115,6 +117,42 @@ nav:
           - v1.2: "admin/release_notes/version_1.2.md"
           - v1.1: "admin/release_notes/version_1.1.md"
           - v1.0: "admin/release_notes/version_1.0.md"
+  - Developer Guide:
+      - Basic:
+          - "dev/basic/index.md"
+          - API Basic: "dev/basic/api.md"
+          - Nautobot App Access: "dev/basic/nautobot_apps.md"
+          - CRUD Operations:
+              - "dev/basic/crud/index.md"
+              - Create: "dev/basic/crud/create.md"
+              - Delete: "dev/basic/crud/delete.md"
+              - Read: "dev/basic/crud/read.md"
+              - Update: "dev/basic/crud/update.md"
+      - Advanced:
+          - "dev/advanced/index.md"
+          - Create: "dev/advanced/create.md"
+          - Delete: "dev/advanced/delete.md"
+          - GraphQL: "dev/advanced/graphql.md"
+          - Read: "dev/advanced/read.md"
+          - Record: "dev/advanced/record.md"
+          - Session: "dev/advanced/session.md"
+          - Update: "dev/advanced/update.md"
+      - Code Reference:
+          - Core:
+              - API: "dev/code_reference/core/api.md"
+              - App: "dev/code_reference/core/app.md"
+              - Endpoint: "dev/code_reference/core/endpoint.md"
+              - GraphQL: "dev/code_reference/core/graphql.md"
+              - Query: "dev/code_reference/core/query.md"
+              - Response: "dev/code_reference/core/response.md"
+              - Util: "dev/code_reference/core/util.md"
+          - Models:
+              - Circuits: "dev/code_reference/models/circuits.md"
+              - DCIM: "dev/code_reference/models/dcim.md"
+              - Extras: "dev/code_reference/models/extras.md"
+              - IPAM: "dev/code_reference/models/ipam.md"
+              - Users: "dev/code_reference/models/users.md"
+              - Virtualization: "dev/code_reference/models/virtualization.md"
 plugins:
   - "search"
   - "mkdocstrings":