Installation
pipx is the recommended way to install Python applications in an isolated environment:
pipx install git+https://github.com/hentai-chan/sms.git
Fire up a debug build in ./venv
:
git clone https://github.com/hentai-chan/sms.git
cd ./speedtest
python -m venv venv/
source venv/bin/activate
pip install -e .
Customize Application Settings
To send a SMS over twilio
you need to set these three values in the configuration file:
sms config --token <auth_token>
sms config --sid <account_sid>
sms config --phone <twilio_number>
Before you register a new twilio
phone number, make sure its able to send a SMS to
other cell phones. If you didn't sign up for a subscription, you will only be able to
send a SMS to your own cell phone that you registered with this website. In general,
cell phone numbers that you want to send a message to need to contain the country code.
Optional: Define an array of excuses that are to be sent (at random) when you use
the --late
option.
sms config --excuses <excuse1,excuse2,...>
Add a new contact to your address book:
sms config --add <name> <phone>
Read the configuration file:
sms config --list
Get help:
sms --help
Command Line Usage
Send a message. Either pass a contact name
from your address book, or pass a
phone number that you want to send a message to:
sms send --msg <msg> --receiver <phone>
You can use the dry run option to preview the command invocation:
sms send --msg "Hello, World!" --receiver haydee --dry-run
sms send --late
Note: You need to configure a home contact (e.g. your significant other) with
sms config --add <name> <phone>
sms config --home <name>
first for this option to work.
Did something went wrong? Copy and paste the information from
sms log --list
to file a new bug report.