cookiecutter-azure-iot-edge-module

Creating an Azure IoT Edge Python module project from this Python package project template.

MIT License

Stars
10

Cookiecutter Template for Azure IoT Edge Python Module

cookiecutter-azure-iot-edge-module creates a base template to start a new Azure IoT Edge Python module

Prerequisites

Install Cookiecutter:

$ pip install -U cookiecutter

Usage

$ cookiecutter https://github.com/Azure/cookiecutter-azure-iot-edge-module --checkout master

and follow the interactive prompts.

If you prefer one-liner:

$ cookiecutter --no-input https://github.com/Azure/cookiecutter-azure-iot-edge-module module_name=<module_name> image_repository=<image_repository> --checkout master

For example:

$ cookiecutter --no-input https://github.com/Azure/cookiecutter-azure-iot-edge-module module_name=filterModule image_repository=localhost:5000/filtermodule --checkout master

Documentation

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

Support

The team monitors the issue section on regular basis and will try to assist with troubleshooting or questions related IoT Edge tools on a best effort basis.

A few tips before opening an issue. Try to generalize the problem as much as possible. Examples include

  • Removing 3rd party components
  • Reproduce the issue with provided deployment manifest used
  • Specify whether issue is reproducible on physical device or simulated device or both
    Also, Consider consulting on the docker docs channel for general docker questions.
Related Projects