https://github.com/netbox-community/cookiecutter-netbox-plugin

Cookiecutter template for easy building NetBox plugins
https://github.com/netbox-community/cookiecutter-netbox-plugin

netbox

Last synced: 2 months ago
JSON representation

Cookiecutter template for easy building NetBox plugins

• Host: GitHub
• URL: https://github.com/netbox-community/cookiecutter-netbox-plugin
• Owner: netbox-community
• License: apache-2.0
• Created: 2023-01-11T01:18:28.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-08-19T07:42:48.000Z (5 months ago)
• Last Synced: 2024-09-27T22:34:40.274Z (4 months ago)
• Topics: netbox
• Language: Python
• Homepage:
• Size: 640 KB
• Stars: 22
• Watchers: 2
• Forks: 7
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Cookiecutter NetBox Plugin

Cookiecutter template for a NetBox plugin, built with popular develop tools and

conform to best practice.

* Documentation: 

**Note:** Plugins from this version target NetBox 4.0+

## Features

This tool will create Python project with the following features:

* [Mkdocs](https://www.mkdocs.org): Writing your docs in markdown style

* Format with [Black](https://github.com/psf/black) and [Isort](https://github.com/PyCQA/isort)

* Lint code with [Flake8](https://flake8.pycqa.org) and [Flake8-docstrings](https://pypi.org/project/flake8-docstrings/)

* [Pre-commit hooks](https://pre-commit.com/): Formatting/linting anytime when commit your code

* [Mkdocstrings](https://mkdocstrings.github.io/): Auto API doc generation

* Continuous Integration/Deployment by [GitHub actions](https://github.com/features/actions), includes:

    - publish documents automatically when CI success

    - extract changelog from CHANGELOG and integrate with release notes automatically

* Host your documentation from [GitHub Pages](https://pages.github.com) with zero-config

## Quickstart

Install the latest Cookiecutter if you haven't installed it yet (this requires Cookiecutter 1.4.0 or higher):

```

pip install -U cookiecutter

```

Generate a Python package project:

```

cookiecutter https://github.com/netbox-community/cookiecutter-netbox-plugin.git

```

Then follow **[Tutorial](docs/tutorial.md)** to finish other configurations.