Skip to content

Commit

Permalink
Updates readme, adds rst readme for pypi, fixes name
Browse files Browse the repository at this point in the history
- makes argcomplete optional
- makes unicodecsv a stated requirement
  • Loading branch information
t413 committed Aug 8, 2014
1 parent 59cf083 commit fc19185
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 16 deletions.
9 changes: 6 additions & 3 deletions README.md
Expand Up @@ -3,6 +3,9 @@ SMS Tools

Multipurpose import / export / merge tool for your text message history. (formally Android-SMS-DB-importer)

Now on [PyPi](https://pypi.python.org/pypi/SMSTools) (the python package index) and available using pip!
`pip install smstools` puts `smstools` in your path, you're ready to roll.

Convert your message history between:
- iOS 5, 6, and 7 databases directly (from backup or from your jailbroken phone directly)
- Android mmssms.db database (directly from phone)
Expand All @@ -23,13 +26,13 @@ Get all of your old messages onto your android phone.

##Howto:

Just run `python sms_tools.py <in> <out>`, sit back, and relax.
Now on [PyPi](https://pypi.python.org/pypi/SMSTools) (the python package index) and available using pip!
`pip install smstools` puts `smstools` in your path, you're ready to roll.

```
usage: sms_tools.py [-h] [--type {xml,json,android,csv,ios5,ios7,ios6}]
usage: smstools [-h] [--type {xml,json,android,csv,ios5,ios7,ios6}]
infiles [infiles ...] outfile
```
Import texts to android sms database file.


##Where do I get my files from?
Expand Down
24 changes: 24 additions & 0 deletions README.rst
@@ -0,0 +1,24 @@
smstools - universal phone sms converter
========================================

Multipurpose import / export / merge tool for your text message history.

Go to the `github page for SMS-Tools`__ for documentation, wiki, issues, etc.

__ https://github.com/t413/SMS-Tools


--------------

Howto:
------

``pip install smstools`` (requires *unicodecsv* package)

``smstools <in> <out>`` (It'll be in your path)

::

usage: smstools[-h] [--type {xml,json,android,csv,ios5,ios7,ios6}]
infiles [infiles ...] outfile

9 changes: 7 additions & 2 deletions bin/smstools
Expand Up @@ -2,14 +2,19 @@
# -*- mode: python -*-
# PYTHON_ARGCOMPLETE_OK

import argparse, argcomplete, os, time
import argparse, os, time
import smstools.core as core

parser = argparse.ArgumentParser(description='Import texts to android sms database file.')
parser.add_argument('infiles', nargs='+', type=argparse.FileType('r'), help='input files, may include multiple sources')
parser.add_argument('outfile', type=argparse.FileType('w'), help='output file to write to.')
parser.add_argument('--type', type=str, help='output type', choices=core.OUTPUT_TYPE_CHOICES.keys())
argcomplete.autocomplete(parser)

try:
import argcomplete
argcomplete.autocomplete(parser)
except:
pass

try:
args = parser.parse_args()
Expand Down
19 changes: 8 additions & 11 deletions setup.py
@@ -1,23 +1,20 @@
import glob
import os
from distutils.core import setup

try:
import pypandoc
description = pypandoc.convert("README.md", 'rst')
print description
except:
print "install pypandoc to get fancy .rst readme"
description = "Universal SMS conversion tool"

def read(fname):
return open(os.path.join(os.path.dirname(__file__), fname)).read()

setup(
name='SMSTools',
version='0.0.8',
name='smstools',
version='0.0.9',
description='Universal SMS conversion tool',
long_description=description,
long_description=read('README.rst'),
author='Tim O\'Brien',
author_email='timo@t413.com',
packages=['smstools', 'smstools.tests'],
scripts=['bin/smstools'],
url='https://github.com/t413/SMS-Tools',
license='CC BY-NC-SA 3.0 US',
install_requires=['unicodecsv>=0.9.3'],
)

0 comments on commit fc19185

Please sign in to comment.