Finalized textme -> elkme

README.md

@@ -1,4 +1,4 @@
-textme
+elkme
 ======
 
 *Command-line texting service provided by 46elks*
@@ -8,20 +8,20 @@ behaviors.
 
 ## Basic usage
 
-`./textme.py "Wow, I'm sending this message from the terminal :)"`
+`./elkme.py "Wow, I'm sending this message from the terminal :)"`
 
 ## Installation
 
 Prefered way of installation is by PyPI
 
-`pip install textme`
+`pip install elkme`
 
 ## Configuration
 
-The easiest way of configuring `textme` is by entering your API credentials from
+The easiest way of configuring `elkme` is by entering your API credentials from
 [the 46elks dashboard](https://www.46elks.com/) into the command-line
 application and adding `--saveconf` like 
-`textme -u APIUSERNAME -p APIPASSWORD --saveconf`. You can also add a default
+`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:
@@ -30,7 +30,7 @@ The configuration file is ini-ish, and looks like:
 [46elks]
 username = REPLACE_ME
 password = REPLACE_ME
-from = textme
+from = elkme
 to = +46700000000
 ````
 

elkme/elks.py

@@ -43,7 +43,7 @@ def send_text(conf, message):
     """Sends a text message to a configuration conf containing the message in
     the message paramter"""
     if not 'from' in conf:
-        conf["from"] = 'textme'
+        conf["from"] = 'elkme'
 
     missing = ''
     if 'username' not in conf:

man/textme.1 → man/elkme.1

@@ -1,20 +1,20 @@
-.TH TEXTME 1 "JUNE 2015" "textme 0.1.1a1" "User Manuals"
+.TH ELKME 1 "JULY 2015" "elkme 0.2.3" "User Manuals"
 .SH NAME
-textme \- the command-line sms interface
+elkme \- the command-line sms interface
 
 .SH SYNOPSIS
-.B textme.py [-h] [-v] [-q] [-f \fIfile\fB] [-t \fITO\fB] [-s \fISENDER\fB] [-u
+.B elkme.py [-h] [-v] [-q] [-f \fIfile\fB] [-t \fITO\fB] [-s \fISENDER\fB] [-u
 \fI USERNAME\fB] [-p \fIPASSWORD\fB] [--saveconf] [-c \fICONFIGFILE\fB] [
 \fImessage \fB[\fImessage ...\fB]]
 
 .SH DESCRIPTION
-.B textme
+.B elkme
 is an application for sending text messages with the
 command line using the 46elks API from https://46elks.com
 
 .SH OPTIONS
 .IP "-h, --help"
-Show an overview of the features of textme and then exits
+Show an overview of the features of elkme and then exits
 .IP "-v, --verbose"
 Show debug output, this will display advanced information about the query
 to the user
@@ -39,20 +39,16 @@ Your API password for 46elks which is a secret key found in the
 46elks dashboard that can be used to authenticate your API calls to the server
 togheter with the API username. Make sure to keep your password a secret.
 .IP --saveconf
-Saves the current configuration to ~/.textme or the configuration file provided
-using \fI-c\fR if present. This allows the user to save settings and not have
-to enter them every time they run textme.
-.B saveconf
-supports saving
-.I --to
-,
-.I --sender
-,
-.I --username
-and
-.I --password
+Saves the current configuration to default location or the configuration 
+location provided using \fI-c\fR if present.
+This allows the user to save settings and not have to enter them every time
+they run elkme.
+
+\fBsaveconf\fR supports saving \fI--to\fR, \fI--sender\fR,
+\fI--username\fR and \fI--password\fR
+
 .IP "-c CONFIGFILE, --config CONFIGFILE"
-Read settings from specified file instead of from ~/.textme
+Read settings from specified file instead of from ~/.elkme
 
 .SH COPYRIGHT
 Licensed under the MIT license.

man/textme.5

@@ -1,14 +1,17 @@
-.TH TEXTME 5 "JUNE 2015" "textme 0.1.1a1" "User Manuals"
+.TH ELKME 5 "JULY 2015" "elkme 0.2.3" "User Manuals"
 .SH NAME
 .B textme
--- configuration file for the textme(1) application
+-- configuration file for the elkme(1) application
+
+.SH PLEASE NOTE
+The configuration file is due to has it's name changed to elkme
 
 .SH DESCRIPTION
 The
 .B textme
 file contains information about authentication and default receiver/sender for
 the
-.B textme(1)
+.B elkme(1)
 application. The file currently only supports sending and receiving text 
 messages using the 46elks API and is in a .ini-like format.
 
@@ -33,4 +36,4 @@ and a ``#'' indicates a comment.
 ~/.textme
 
 .SH SEE ALSO
-textme(1)
+elkme(1)

setup.py

@@ -3,7 +3,7 @@
 from setuptools import setup, find_packages
 
 setup(name='elkme',
-      version='0.2.2',
+      version='0.2.3',
       description='Command-line tool for sending SMS',
       long_description="""elkme is a command-line tool for sending SMS using
       the 46elks platfrom from the terminal.""",