added tox config + docs

daveoncode · daveoncode · commit 9d3dc9d15c05 · 2015-07-28T16:05:40.000+02:00
diff --git a/MANIFEST b/MANIFEST
@@ -0,0 +1,2 @@
+# file GENERATED by distutils, do NOT edit
+setup.py
diff --git a/README.md b/README.md
@@ -3,6 +3,8 @@
 A small utility library for strings.
 
 - simple and pythonic
+- no external dependencies
+- fully documented
 - PEP8 complaint
 - 100% code coverage
-- works with python 2.7+ and 3+
+- tested against multiple python versions (2.7, 3.2, 3.3, 3.4)
diff --git a/setup.py b/setup.py
@@ -0,0 +1,10 @@
+from distutils.core import setup
+
+setup(
+    name='python-string-utils',
+    version='0.0.0',
+    description='Utility functions for strings',
+    author='Davide Zanotti',
+    author_email='davidezanotti@gmail.com',
+    # url='https://www.python.org/sigs/distutils-sig/',
+)
diff --git a/string_utils.py b/string_utils.py
@@ -50,6 +50,16 @@ def is_email(string):
 
 
 def is_credit_card(string, card_type=None):
+    """
+    Checks if a string is a valid credit card number.
+    If card type is provided then it checks that specific type,
+    otherwise any known credit card number will be accepted.
+
+    :param string: String to check.
+    :param card_type: Card type (can be: 'VISA', 'MASTERCARD', 'AMERICAN_EXPRESS', 'DINERS_CLUB', 'DISCOVER', 'JCB'
+    or None). Default to None (any card).
+    :return: :raise KeyError:
+    """
     if card_type:
         if card_type not in CREDIT_CARDS:
             raise KeyError(
diff --git a/tox.ini b/tox.ini
@@ -0,0 +1,11 @@
+# Tox (http://tox.testrun.org/) is a tool for running tests
+# in multiple virtualenvs. This configuration file will run the
+# test suite on all supported python versions. To use it, "pip install tox"
+# and then run "tox" from this directory.
+
+[tox]
+envlist = py27, py32, py33, py34
+# py35, pypy, jython
+
+[testenv]
+commands = python -m unittest discover

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# file GENERATED by distutils, do NOT edit`
	`2`	`+setup.py`