Skip to content

Latest commit

 

History

History
44 lines (29 loc) · 1.06 KB

README.md

File metadata and controls

44 lines (29 loc) · 1.06 KB

elkme

Command-line texting service provided by 46elks

This tool is still quite rough, and may behave in strange, un-accounted for behaviors. It is also prone for random breaking changes, although we'll try to keep that to a minimum ;)

Please open an issue for anything that looks like a bug.

Basic usage

python -m elkme.main "Wow, I'm sending this message from the terminal :)"

or (if installed)

elkme "Good morning, upper east side"

Installation

elkme supports Python versions 2.7 and 3.3+. Prefered way of installation is by PyPI:

pip install elkme

Configuration

The easiest way of configuring elkme is by entering your API credentials from the 46elks dashboard into the command-line application and adding --saveconf like elkme -u APIUSERNAME -p APIPASSWORD --saveconf. You can also add a default sender and receiver by adding the --to and --sender options.

The configuration file is ini-ish, and looks like:

[46elks]
username = REPLACE_ME
password = REPLACE_ME
from = elkme
to = +46700000000