README.md

Python example module

This is an example of a Viam module using our Python SDK. This repo shows how to:

• Use a Python virtualenv to install your module's dependencies on the robot
• Write a simple module in Python
• Use CI to automatically publish a new version when you create a Github release

Forking this repo

If you want to copy this repo and run it yourself, you'll need to make a few changes:

Create your own meta.json

1. Get the Viam CLI (todo: link to docs)
2. Rename the existing meta.json to meta.json.old
3. Use viam module create to create a copy in your own account
4. Copy all the fields except name from meta.json.old (your choice whether to make it public or private)

Change all references to the viam namespace

You'll need to change all the namespace references in the codebase ('viam') to the namespace of your organization on Viam.

1. You should already have done this in meta.json above
2. In the "model" field in meta.json (on line 9 when this was written)
3. In the ModelFamily in gas_sensor.py, around here.

Set a secret if you want to use Github CI

Instructions for setting the secret are here.