1616
1717 < a href ="#elkme "> elkme</ a > |
1818 < a href ="#sdk "> Python SDK</ a > |
19- < a href ="#preselks " > About 46elks </ a >
19+ < a href ="#ineedsomebody " > Help! </ a >
2020
2121 </ nav >
2222
2323 < div id ="content ">
2424 < h1 > The Elkme Suite</ h1 >
25+ < h2 > Sending SMS from your Terminal</ h2 >
26+
27+ < div id ="asciinema-elkme-demo " class ="hide-controls ">
28+ <!--
29+ asciinema is *really* neat, you should really try it out
30+ you're looking at this.
31+
32+ Lot's of thanks to Marcin Kulik for developing it :)
33+
34+ https://asciinema.org/
35+ -->
36+ </ div >
37+ < script >
38+ asciinema . player . js . CreatePlayer ( 'asciinema-elkme-demo' , 'elkme.json' , { 'height' : 4 , 'width' : 70 , 'autoPlay' : true } ) ;
39+ </ script >
2540
2641 < section >
2742 < p >
28- Elkme is a set of tools to help you integrate SMS with your
29- UNIX/Linux/macOS prompt and your Python applications and
30- scripts.
43+
3144 </ p >
3245 </ section >
3346
@@ -36,76 +49,94 @@ <h2 class="cmd" id="elkme">elkme</h2>
3649 < section >
3750 < p >
3851 < tt > elkme</ tt > is a tool for empowering your UNIX® shell with
39- the ability to send SMS from the command-line.
52+ the ability to send SMS from the command-line using the
53+ < a href ="https://www.46elks.com/ "> 46elks API</ a > .
4054 </ p >
4155
4256 < p >
43- Utilizing the < a href ="https://www.46elks.com/ "> 46elks API</ a >
44- to conveniently send SMS from your command-line.
45- You can with minimal effort set up < tt > cron</ tt > to send you
46- information about load, the latest podcast or the progress of
47- downloading 7½ hours of Norwegian trains (in HD)< sup id ="fnm1 "> < a href ="#fn1 "> 1</ a > </ sup > .
57+ You can with minimal effort set up a cronjob to send you a SMS
58+ with information about load, the status of the
59+ backup-task or the progress of downloading 7½ hours of
60+ Norwegian trains (in HD)< sup id ="fnm1 "> < a href ="#fn1 "> 1</ a > </ sup > .
4861 </ p >
49- < p >
50- The demonstration below shows how easy it is to send your uptime
51- and load in a SMS using < tt > elkme</ tt > after initial configuration.
52-
53- </ p >
54- </ section >
55-
56- < div id ="asciinema-elkme-demo " class ="hide-controls "> </ div >
57- < script >
58- asciinema . player . js . CreatePlayer ( 'asciinema-elkme-demo' , 'elkme.json' , { 'height' : 4 , 'width' : 70 , 'autoPlay' : true } ) ;
59- </ script >
60-
61- < section >
6262 < p >
6363 The idea of < tt > elkme</ tt > is to provide sysadmins, developers
6464 and power users with a toolkit to communicate with any phone
6565 anywhere at any time from a command-line. SMS is < strong > the</ strong >
6666 de facto standard for real-time notifications, and < tt > elkme</ tt >
67- makes SMS as convenient and accessible as using < tt > cat </ tt > or < tt > echo </ tt > .
67+ makes using SMS as convenient and accessible as using < tt > less </ tt > .
6868 </ p >
6969 </ section >
7070
7171 < h3 > Installation</ h3 >
7272 < section >
7373 < p >
74- < tt > elkme</ tt > is available as source on < a href ="https://github.com/46elks/elkme "> github.com/46elks/elkme</ a >
75- and compatible with Python 2 and 3 (with < tt > requests</ tt > installed).
76- </ p >
77- < p >
78- You may also install < tt > elkme</ tt > from the pypi package
74+ Install < tt > elkme</ tt > from the pypi package
7975 < a href ="https://pypi.python.org/pypi/elkme "> elkme</ a >
80- by using < tt > pip</ tt > :
76+ using < tt > pip</ tt > :
8177 </ p >
8278
8379 < code class ="cmd root ">
8480 pip install elkme
8581 </ code >
82+
83+ < p >
84+ The source code for < tt > elkme</ tt > is also available on
85+ < a href ="https://github.com/46elks/elkme "> github.com/46elks/elkme</ a >
86+ and is compatible with Python 2 and 3 (with the sole dependency
87+ < tt > requests</ tt > ).
88+ </ p >
89+
90+ < p >
91+ You may have to run < tt > pip</ tt > in a < a href ="https://virtualenv.pypa.io/en/stable/ "> virtualenv</ a >
92+ or as root using < tt > sudo</ tt >
93+ if you are trying to install < tt > elkme</ tt > and see something
94+ similar to the message below.
95+ </ p >
96+
97+ < code class ="cmd output ">
98+ OSError: [Errno 13] Permission denied: '/usr/lib/pthon3.5/site-packages/requests-2.9.1.dist-info/DESCRIPTION.rst'
99+ </ code >
100+
101+ < p >
102+ Congratulations, you have now installed < tt > elkme</ tt > !
103+ < br /> You can now verify that it works:
104+ </ p >
105+
106+ < code class ="cmd ">
107+ elkme --version
108+ </ code >
109+
110+ < code class ="output ">
111+ elkme 0.4.5 (release date 2016-07-26)< br />
112+ (c) 2015-2016 46elks AB <
[email protected] >
113+ </ code >
114+
86115 </ section >
87116
88117 < h3 > Setup</ h3 >
89118
90119 < section >
91120 < p >
92- Getting started with < tt > elkme</ tt > by registering for a
121+ Get started with < tt > elkme</ tt > by registering for a
93122 < a href ="https://www.46elks.com/ "> 46elks</ a > account and extracting
94123 your API keys from the dashboard.
95124 </ p >
96125
126+ < p >
127+ Let < tt > elkme</ tt > generate your configuration file< sup id ="fnm2 "> < a href ="#fn2 "> 2</ a > </ sup >
128+ for you so you can use < tt > elkme</ tt > whenever you want without
129+ having to look for your credentials by using the
130+ < tt > elkme --saveconf</ tt > command as seen below.
131+ </ p >
132+
97133 < code class ="cmd ">
98134 elkme --saveconf -u < span class ="highlight "> (API key)</ span > -p
99135 < span class ="highlight "> (API secret)</ span > --to
100136 < span class ="highlight "> (Your Phonenumber)</ span >
101- --from < span class ="highlight "> $(hostname )</ span >
137+ --from < span class ="highlight "> (Your Phonenumber )</ span >
102138 </ code >
103139
104- < p >
105- This saves your default details and you may start sending SMS from
106- your command-line, cronjobs and by utilizing the elkme Python SDK.
107- </ p >
108-
109140 < code class ="cmd ">
110141 elkme < span class ="highlight "> "Good morning, upper east side"</ span >
111142 </ code >
@@ -118,19 +149,19 @@ <h2 id="sdk">elkme Python SDK</h2>
118149 to sending SMS from the command-line, it is also the reference
119150 implementation for connecting to the 46elks API from Python.
120151 </ p >
152+ < h4 > Note:</ h4 >
121153 < p >
122- < h4 > Note:</ h4 >
123154 The < tt > elkme</ tt > Python SDK is in early-beta and is prone
124155 to change with every release.
125156 </ p >
126157 </ section >
127158
128- < h2 id ="preselks " > About 46elks </ h2 >
159+ < h2 id ="ineedsomebody " > Help & Support </ h2 >
129160 < section >
130- < h4 >
131- Adding SMS and voice to your application or service should be
132- easy
133- </ h4 >
161+ < p >
162+ For any and all support on Elkme, please contact
163+ 164+ </ p >
134165 </ section >
135166
136167 < footer >
@@ -140,6 +171,12 @@ <h2>Footnotes</h2>
140171 < a href ="#fnm1 "> Footnote 1</ a > —
141172 < a href ="https://nrkbeta.no/2009/12/18/bergensbanen-eng/ "> https://nrkbeta.no/2009/12/18/bergensbanen-eng/</ a > . Enjoy!
142173 </ li >
174+ < li id ="fn2 ">
175+ < a href ="#fnm2 "> Footnote 2</ a > —
176+ The < tt > elkme</ tt > configuration files are placed in
177+ < tt > ~/.config/elkme</ tt > on Linux and < tt > ~/Library/Application\ Support/elkme</ tt >
178+ on macOS
179+ </ li >
143180 </ ul >
144181 </ footer >
145182 </ div >
0 commit comments