Quick start

requirements

You need Python installed on your computer (version 3.7 or higher). Refer to this guide if you need help.

Quickstart Using init script (Linux & Mac)

Octopus Sensing comes with a script that helps you quickly start a project. It uses Pipenv to create a virtual environment in order to keep everything clean. It will also create a sample application.

mkdir my-awesome-project
cd my-awesome-project
curl --output init.sh https://raw.githubusercontent.com/nastaran62/octopus-sensing/master/init_script/init.sh
# It's a good idea to read any script before executing it.
bash ./init.sh
rm ./init.sh

The created main.py file is an example application. To run it:

pipenv run python main.py

Note that the script only installs Camera module. See Installation to learn how to install other device modules.

If you don’t want or can’t use the script, see Installation. It includes a troubleshooting section.