semvec/pypi-packages huggingface dataset:
netbox-initializers 4.4.0
Load initial data into Netbox
Requires Python: >=3.10

# Netbox Initializers Plugin

Load data from YAML files into Netbox

## Installation

First activate your virtual environment where Netbox is installed, the install the plugin version correspondig to your Netbox version.

```bash
pip install "netbox-initializers==4.4.*"
```

Then you need to add the plugin to the `PLUGINS` array in the Netbox configuration.

```python
PLUGINS = [
    'netbox_initializers',
]
```

## Getting started

At first you need to start with writing the YAML files that contain the initial data. To make that easier the plugin includes example files for all supported initializers. To access those examples you can copy them into a directory of your choosing and edit them there. To copy the files run the following command (in your Netbox directory):

```bash
./manage.py copy_initializers_examples --path /path/for/example/files
```

After you filled in the data you want to import, the import can be started with this command:

```bash
./manage.py load_initializer_data --path /path/for/example/files
```

## Netbox Docker image

The initializers where a part of the Docker image and where then extracted into a Netbox plugin. This was done to split the release cycle of the initializers and the image.
To use the new plugin in a the Netbox Docker image, it musst be installad into the image. To this, the following example can be used as a starting point:

```dockerfile
FROM netboxcommunity/netbox:v4.4
RUN /opt/netbox/venv/bin/pip install "netbox-initializers==4.4.*"
```
sphinx-list-items 1.0.0
A Sphinx extension to list items such as figures, tables, versionadded, etc.
Requires Python: >=3.7
Keywords: Sphinx, Extension, list, sphinx-list, list-items


# sphinx-list-items
[![GPL3 License](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://spdx.org/licenses/GPL-3.0-only.html)
[![PyPi Status](https://img.shields.io/pypi/status/sphinx-list-items.svg?style=flat)](https://pypi.python.org/pypi/sphinx-list-items)
[![PyPi Version](https://img.shields.io/pypi/v/sphinx-list-items.svg?style=flat)](https://pypi.python.org/pypi/sphinx-list-items)

A Sphinx extension to automatically list figures, tables, and Sphinx version directives (`versionadded`, `versionchanged`, `deprecated`, `versionremoved`) in your documentation. Output as a bulleted list or a customizable table, with filtering and advanced options.

## Features

- List all figures or tables in your documentation
- List Sphinx version directives (with prefix-stripping for cleaner output)
- Output as a bulleted list or a table (with custom columns)
- Filter version items by version number
- Works with cross-references and section links

## Installation

```bash
pip install sphinx-list-items
```

Or for development:

```bash
pip install -e .
```

## Setup

Add to your `conf.py`:

```python
extensions = ['sphinx_list_items']
```

## Usage

### List all figures (as a list)

```rst
.. list-items:: figures
   :list:
```

### List all figures (as a table)

```rst
.. list-items:: figures
   :table:
```

### List all tables (as a list)

```rst
.. list-items:: tables
   :list:
```

### List all tables (as a table)

```rst
.. list-items:: tables
   :table:
```

### List Sphinx version directives (as a list)

```rst
.. list-items:: versionadded
   :list:

.. list-items:: versionchanged
   :list:

.. list-items:: deprecated
   :list:

.. list-items:: versionremoved
   :list:
```

### List Sphinx version directives (as a table)

```rst
.. list-items:: versionadded
   :table:
```

### Filter version items by version

```rst
.. list-items:: versionadded
   :table:
   :version: 0.0.2
```

### Custom columns for tables

```rst
.. list-items:: versionchanged
   :table: docname, version, text, type
```

## Advanced

- All output supports cross-references to the source location.
- Version directive output strips the prefix (e.g., "Added in version 1.0.0:") for clean summaries.
- You can use `:list:` or `:table:` for any supported type.
- For tables, you can specify custom columns (e.g., `:table: id, caption`).

## Example

See the [examples](doc/content/examples.rst) and [specimens](doc/content/specimens.rst) in this repository for real-world usage.