Skip to content

Commit

Permalink
Merge pull request #13 from olleolleolle/master
Browse files Browse the repository at this point in the history
Improved README and reduced dependencies and linted
  • Loading branch information
oau committed Oct 23, 2012
2 parents 0d408a7 + 2aa3463 commit f735b7a
Show file tree
Hide file tree
Showing 6 changed files with 204 additions and 179 deletions.
36 changes: 19 additions & 17 deletions README.md
@@ -1,6 +1,20 @@
# smskrupp # smskrupp


A project using [gammu](https://github.com/gammu/gammu) to handle sms lists. smskrupp **implements SMS lists** on top of [gammu](https://github.com/gammu/gammu). Gammu does all the lower-level talking to the modem.

It has a command-line interface and a Web interface for list management.

## Usage

Use the `smskrupp` command to manage groups:

$ ./smskrupp add-group test t
$ ./smskrupp add-member 0731234567 member1 test
$ ./smskrupp add-member 0731234568 member2 test
$ ./smskrupp set-sender 0731234567 test
$ ./smskrupp list-members test

Now if you have gammu-smsd set up correctly you should be able to send a message from 0731234567 to the phone you've setup with gammu and it will deliver to all members in the group.


## Setup ## Setup


Expand All @@ -14,32 +28,20 @@ If you want the webapp you also need:


# apt-get install python-bcrypt python-flask # apt-get install python-bcrypt python-flask


Setting up the db: Setting up the sqlite database:


$ cat sql/*.sql | sqlite3 smskrupp.db $ cat sql/*.sql | sqlite3 smskrupp.db && cat sql/*.sql | sqlite3 smskrupp-test.db


Create the config file: Create the config file:


$ cp config.py.default config.py $ cp config.py.default config.py


Edit the config file so it points to the correct places. Edit the config file so it points to the correct locations.


For gammu to work you also need a gammu-smsdrc, there is an example file in the doc/ directory. For gammu to work you also need a gammu-smsdrc, there is an example file in the doc/ directory.


## Usage

use smskrupp command to manage groups:

$ smskrupp add-group test t
$ smskrupp add-member 0731234567 member1 test
$ smskrupp add-member 0731234568 member2 test
$ smskrupp set-sender 0731234567 test
$ smskrupp list-members test

Now if you have gammu-smsd setup correctly you should be able to send a message from 0731234567 to the phone you've setup with gammu and it will deliver to all members in the group.

## Tests ## Tests


If your config.py points to a test-db and a test-smsdrc, simply run If your config.py points to a test-db and a test-smsdrc -- this is the default configuration -- simply run:


$ nosetests $ nosetests
3 changes: 2 additions & 1 deletion config.py.default
@@ -1,8 +1,9 @@
class Config: class Config:
db = 'smskrupp.db' db = 'smskrupp.db'
smsdrc = '/etc/gammu-smsdrc' smsdrc = '/etc/gammu-smsdrc'
test_db = 'tmp.db' test_db = 'smskrupp-test.db'
test_smsdrc = 'test-gammu-smsdrc' test_smsdrc = 'test-gammu-smsdrc'
send_prefix='#'
admin_prefix='/' admin_prefix='/'
log = 'smskrupp.log' log = 'smskrupp.log'
default_phone = 'phone1' default_phone = 'phone1'
Expand Down

0 comments on commit f735b7a

Please sign in to comment.