bucket_90/python-netbox-inventory

   1 # Buildsheet autogenerated by ravenadm tool -- Do not edit.
   2
   3 NAMEBASE=               python-netbox-inventory
   4 VERSION=                1.1.1
   5 KEYWORDS=               python
   6 VARIANTS=               py310 v11
   7 SDESC[py310]=           Inventory asset management in NetBox (3.10)
   8 SDESC[v11]=             Inventory asset management in NetBox (3.11)
   9 HOMEPAGE=               none
  10 CONTACT=                Python_Automaton[python@ironwolf.systems]
  11
  12 DOWNLOAD_GROUPS=        main
  13 SITES[main]=            PYPIWHL/c0/31/bd6289264796c6f7d55479de1b1333fc8ae8339f65ecaa3f010d32910c1c
  14 DISTFILE[1]=            netbox_inventory-1.1.1-py3-none-any.whl:main
  15 DF_INDEX=               1
  16 SPKGS[py310]=           single
  17 SPKGS[v11]=             single
  18
  19 OPTIONS_AVAILABLE=      PY310 PY311
  20 OPTIONS_STANDARD=       none
  21 VOPTS[py310]=           PY310=ON PY311=OFF
  22 VOPTS[v11]=             PY310=OFF PY311=ON
  23
  24 DISTNAME=               netbox_inventory-1.1.1.dist-info
  25
  26 GENERATED=              yes
  27
  28 [PY310].USES_ON=                        python:py310,wheel
  29
  30 [PY311].USES_ON=                        python:v11,wheel
  31
  32 [FILE:2979:descriptions/desc.single]
  33 # NetBox Inventory Plugin
  34
  35 A [Netbox] plugin for hardware inventory.
  36
  37 ## Features
  38
  39 Keep track of your hardware, whether it is installed or in storage. You can
  40 define assets that represent hardware that can be used as a device, module
  41 or
  42 inventory item in NetBox.
  43
  44 Each asset can have a storage location defined, when not in use. You can
  45 assign
  46 an asset to a device or module. The plugin can keep serial number and asset
  47 tag
  48 between asset and device or module in sync if enabled in settings.
  49
  50 To properly support inventory items (that are used in NetBox to model SFP
  51 and
  52 similar modules) the plugin defines inventory item types that are
  53 equivalent to
  54 device types and module types.
  55
  56 ### Automatic management of asset status
  57
  58 Each asset has a status attribute that can indicate use of the asset. These
  59 statuses can be set as needed by each NetBox installation.
  60
  61 Two statuses can have a special meaning. One to indicate asset is in
  62 storage and one
  63 to indicate asset is in use.
  64
  65 netbox_inventory can automatically set status to the value specified in
  66 `used_status_name` configuration item when an asset is assigned to a
  67 device, module
  68 or inventory item.
  69
  70 When you remove an asset from device, module or inventory item the plugin
  71 will set
  72 asset status to `stored_status_name` configuration item.
  73
  74 To disable automatically changing status, set these two config parameters
  75 to `None`.
  76
  77 ### Prevent unwanted changes for tagged assets
  78
  79 With `asset_disable_editing_fields_for_tags` and
  80 `asset_disable_deletion_for_tags` you can prevent changes to specified
  81 asset data for assets that have certain tags attached. Changes are only
  82 prevented via web interface. API modifications are allowed.
  83
  84 The idea is that an external system uses some assets stored in
  85 netbox_inventory, and you want to prevent accidental changes to data
  86 directly in NetBox web interface. Only that external system should modify
  87 the data.
  88
  89 ## Compatibility
  90
  91 This plugin requires netbox version 3.3 to work.
  92
  93 | NetBox Version | Plugin Version |
  94 |----------------|----------------|
  95 |       3.3      |      1.0.x     |
  96 |       3.4      |    (none yet)  |
  97
  98 ## Installing
  99
 100 Review [official Netbox plugin documentation] for installation
 101 instructions.
 102
 103 You install the plugin from pypi with pip. Make sure you activate Netbox's
 104 virtual
 105 environment first:
 106
 107 ```bash
 108 $ source /opt/netbox/venv/bin/activate
 109 (venv) $ pip install netbox-inventory
 110 ```
 111
 112 For adding to a NetBox Docker setup see
 113 [the general instructions for using netbox-docker with plugins].
 114
 115 You can install a development version directly from GitHub:
 116
 117 ```bash
 118 pip install git+https://github.com/ArnesSI/netbox-inventory.git@master
 119 ```
 120
 121 or by adding to your `local_requirements.txt` or `plugin_requirements.txt`
 122 (netbox-docker):
 123
 124 ```bash
 125 git+https://github.com/ArnesSI/netbox-inventory.git@master
 126 ```
 127
 128 After installation, enable the plugin in
 129 `/opt/netbox/netbox/netbox/configuration.py`,
 130  or if you use netbox-docker, your `/configuration/plugins.py` file :
 131
 132 ```python
 133
 134
 135 [FILE:118:distinfo]
 136 2e95bc084ddc3b244880ed462489f165a4d50c52df3f8b94844ab03117bdc3c1        52109 netbox_inventory-1.1.1-py3-none-any.whl
 137