Prompts
Prompts¶
When you create a package, you are prompted to enter these values.
Templated Values¶
The following appear in various parts of your generated project.
Templated Values¶
The following appear in various parts of your generated project.
- plugin_name
- The base name of your plugin (without "NetBox" or "Plugin"). This is used to initialize most of the other settings.
- project_name
- The name of your new Python package project. This is used in documentation, so spaces and any characters are fine here.
- hyphenated
- The name of your Python package for PyPI, also as the repository name of GitHub. Typically, it is the slugified version of project_name.
- underscored
- The name of the python module and directory in the project.
- project_short_description
- A 1-sentence description of what your Python package does.
- full_name
- Your full name.
- Your email address.
- github_username
- Your GitHub username (or organization name).
- version
- The starting version number of the package.
Options¶
The following package configuration options set up different features for your project.
- open_source_license
- Choose a license. Options: [1. Apache-2.0, 2. MIT, 3. BSD, 4. ISC, 5. GPL-3.0-only, 6. Not open source]
except above settings, for CI/CD, you'll also need configure gitub repsitory secrets at page repo > settings > secrtes, and add the following secrets:
- PERSONAL_TOKEN (required for publishing document to git pages)
- TEST_PYPI_API_TOKEN (required for publishing dev release to testpypi)
- PYPI_API_TOKEN (required for publish )