Added basic release information

Author: tobiasge

README.md

@@ -6,7 +6,7 @@ Load data from YAML files into Netbox
 
 First activate your virtual environment where Netbox is installed, the install the plugin version correspondig to your Netbox version.
 ```bash
-pip install "netbox-initializers==3.2"
+pip install "netbox-initializers==3.2.*"
 ```
 
 ### Getting started
@@ -30,6 +30,6 @@ The initializers where a part of the Docker image and where then extracted into
 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:3.2
-RUN /opt/netbox/venv/bin/pip install "netbox-initializers==3.2"
+FROM netboxcommunity/netbox:v3.2
+RUN /opt/netbox/venv/bin/pip install "netbox-initializers==3.2.*"
 ```

Release.md

@@ -0,0 +1,38 @@
+# Build a release
+
+Please follow these steps to produce a release
+
+## Checkout correct branch
+
+Checkout the branch for which the release is to be build. If no branch exists for the new release one must be created. The name must correspond to the Netbox version in the format "MAJOR.MINOR".
+
+## Set version number
+
+The version number in `README.md`, `setup.py` and the `NetBoxInitializersConfig` need to be updated.
+
+## Build the packages
+
+Install the needed Python packages for the build:
+
+```bash
+pip install --upgrade pip setuptools wheel twine build
+```
+
+Then run the build for the wheel and source distributions:
+
+```bash
+python -m build --sdist
+python -m build --wheel
+```
+
+Check the release with twine:
+
+```bash
+twine check dist/*
+```
+
+## Upload packeges to PyPi
+
+```bash
+twine upload dist/*
+```

src/netbox_initializers/__init__.py

@@ -5,7 +5,7 @@ class NetBoxInitializersConfig(PluginConfig):
     name = 'netbox_initializers'
     verbose_name = 'NetBox Initializers'
     description = 'Load initial data into Netbox'
-    version = '3.2'
+    version = '3.2.0'
     base_url = 'initializers'
     min_version = '3.2.0'
     max_version = '3.2.99'

src/setup.py

@@ -1,12 +1,19 @@
 from setuptools import find_packages, setup
 
+from pathlib import Path
+this_directory = Path(__file__).parent
+
+long_description = (this_directory / ".." / "README.md").read_text()
+
 setup(
     name="netbox-initializers",
-    version="3.2",
+    version="3.2.0",
     description="Load initial data into Netbox",
     install_requires=["ruamel.yaml==0.17.21"],
     packages=find_packages() + ["netbox_initializers.initializers.yaml"],
     package_data={"netbox_initializers.initializers.yaml": ["*.yml"]},
     include_package_data=True,
     zip_safe=False,
+    long_description=long_description,
+    long_description_content_type='text/markdown'
 )