Merge pull request #5 from unnonouno/readme

Write README

LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2016 Yuya Unno.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

MANIFEST.in

@@ -0,0 +1,4 @@
+include README.md
+include LICENSE
+recursive-include excelcsv *.py
+recursive-include tests *.py

README.md

@@ -0,0 +1,32 @@
+[![Build Status](https://travis-ci.org/unnonouno/excelcsv.svg?branch=master)](https://travis-ci.org/unnonouno/excelcsv)
+[![Coverage Status](https://coveralls.io/repos/github/unnonouno/excelcsv/badge.svg?branch=master)](https://coveralls.io/github/unnonouno/excelcsv?branch=master)
+
+# excelcsv
+
+## Requirements
+
+- Python 2.7, 3,4, 3.5
+
+## Installation
+
+```
+$ pip install excelcsv
+```
+
+## Usage
+
+```
+with excelcsv.read_excel_tsv(path) as reader:
+    for row in reader:
+        do_something(row)
+```
+
+```
+with excelcsv.write_excel_tsv(path) as writer:
+    for row in rows:
+        writer.writerow(row)
+```
+
+## License
+
+MIT License.

excelcsv/__init__.py

@@ -1,9 +1,12 @@
 import contextlib
 import csv
 import io
+import pkg_resources
 import sys
 
 
+__version__ = pkg_resources.get_distribution('excelcsv').version
+
 if sys.version_info[0] > 2:
     reader = csv.reader
     writer = csv.writer

setup.py

@@ -1,10 +1,20 @@
+import os
 from setuptools import setup
 
+
+def read(name):
+    return open(os.path.join(os.path.dirname(__file__), name)).read()
+
+
 setup(
     name='excelcsv',
     version='0.0.0',
+    description='excelcsv: CSV utility for Excel',
+    long_description=read('README.md'),
     author='Yuya Unno',
     author_email='unnonouno@gmail.com',
+    url='https://github.com/unnonouno/excelcsv',
+    license='MIT',
     packages=['excelcsv'],
     tests_require=['nose', 'coverage'],
     test_suite='nose.collector',