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

A plugin cookiecutter for netbox
https://github.com/rixx/netbox-plugin-cookiecutter

cookiecutter cookiecutter-template netbox netbox-plugin

Last synced: 5 days ago
JSON representation

A plugin cookiecutter for netbox

• Host: GitHub
• URL: https://github.com/rixx/netbox-plugin-cookiecutter
• Owner: rixx
• Created: 2022-07-27T22:12:01.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-03-02T19:36:54.000Z (over 1 year ago)
• Last Synced: 2024-04-14T23:00:26.251Z (7 months ago)
• Topics: cookiecutter, cookiecutter-template, netbox, netbox-plugin
• Language: Python
• Homepage:
• Size: 13.7 KB
• Stars: 6
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

        
netbox-plugin-cookiecutter

==========================

A simple `cookiecutter`_ template to bootstrap a `netbox`_ plugin.

Usage

-----

Let's pretend you want to create a netbox plugin called "superplugin".

First, create a virtual environment and install the ``cookiecutter``

package using pip. Next, use it to bootstrap your project folder::

    $ cd 

    $ cookiecutter https://github.com/rixx/netbox-plugin-cookiecutter

You'll be prompted for some questions. Answer them, and you will find a

project folder created for you::

    repo_name [netbox-superplugin]: netbox-superplugin

    repo_url [GitHub repository URL]: https://github.com/myuser/netbox-superplugin

    module_name [netbox_superplugin]: netbox_superplugin

    human_name [The netbox super plugin]: Super Plugin

    author_name [Your name]: J Random Developer

    author_email [Your email]: [email protected]

    short_description [Short description]: The best plugin

Now, change to the newly created directory::

    $ cd netbox-superplugin

Voilà, there's your plugin structure! See netbox' `documentation`_ for more info.

------

Work on this project was kindly sponsored by `Globalways`_.

.. image:: https://globalways.net/wp-content/uploads/2020/11/Varianten_Globalways_Logo_Farbe_Globalways_Logo_Farbe_2.svg

   :target: https://globalways.net

   :alt: Globalways logo

.. _netbox: https://github.com/netbox-community/netbox

.. _cookiecutter: https://github.com/audreyr/cookiecutter

.. _documentation: https://docs.netbox.dev/en/stable/plugins/development/

.. _globalways: https://www.globalways.net