https://github.com/jacobmarks/twilio-automation-plugin
Automate data ingestion into FiftyOne with Twilio
https://github.com/jacobmarks/twilio-automation-plugin
automation computer-vision fiftyone ingestion plugin python twilio
Last synced: 6 days ago
JSON representation
Automate data ingestion into FiftyOne with Twilio
- Host: GitHub
- URL: https://github.com/jacobmarks/twilio-automation-plugin
- Owner: jacobmarks
- Created: 2023-08-24T06:25:24.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-10-24T21:02:57.000Z (over 2 years ago)
- Last Synced: 2025-10-31T05:55:04.372Z (8 months ago)
- Topics: automation, computer-vision, fiftyone, ingestion, plugin, python, twilio
- Language: Python
- Homepage:
- Size: 16.6 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Twilio Automation Plugin
This plugin is a Python plugin that allows you to automate data ingestion with [twilio](https://www.twilio.com/en-us). Take pictures with your phone and send them to a Twilio number. The plugin will automatically download the images and add them to your dataset.
✨☕💻✨ This plugin is a direct byproduct of the hackathon at the [Twilio SIGNAL Creator Summit 2023](https://signal.twilio.com/2023/creator-summit).
This plugin demonstrates how to do the following:
- use Python to create an operator with different options depending on user choices
- add a custom operator icon via the operators `icon` property
- download images from URL — with authentication — and add them to the dataset
## Installation
### Twilio Setup
Before installing this plugin, you must set up your Twilio account:
1. [Create a Twilio account](https://www.twilio.com/try-twilio). Twilio offers a free trial, so you can try this out without paying anything.
2. Buy (with the free trial credits) a toll-free phone number that can receive MMS messages. You can do this from the [Twilio Console](https://www.twilio.com/console/phone-numbers/search).
3. Go to the [Twilio Console](https://console.twilio.com/) and copy the "Account SID", "Auth Token", and "My Twilio phone number" values. Add these values as environment variables in your shell rc (`.bashrc`, `.zshrc`, etc.)):
```shell
export TWILIO_ACCOUNT_SID=
export TWILIO_AUTH_TOKEN=
export TWILIO_PHONE_NUMBER=
```
💡 You will need to restart your shell for these environment variables to take effect.
4. Install the [twilio Python helper library](https://github.com/twilio/twilio-python/tree/main).
```shell
pip install twilio
```
### Plugin Installation
To install the plugin, run the following command:
```shell
fiftyone plugins download https://github.com/jacobmarks/twilio-automation-plugin
```
## Operators
### `add_twilio_images`
Add images received by your Twilio number to the dataset. This operator only adds images that have not already been added to the dataset.
When you run the operator, it will download the images, assign them a filepath, and add them to the dataset with metadata.
#### Filtering by message body
When executing the operator, you can filter the images that are added to the dataset by the message body.
## Notes
### Local datasets only
This plugin is only meant for local datasets. If
you are working with large-scale, remotely hosted datasets, you likely need a
more robust solution 👉 [FiftyOne Teams](https://voxel51.com/fiftyone-teams/)
### Cost
This plugin uses Twilio's MMS service, which costs $0.02 message received. You can send up to 10 images per message, so the cost is $0.002 per image. If you are using the free trial, you will have $13 in credits left after buying a phone number, which is enough for 6,500 images.