From fc59dcc8136d13bd97c50c1ee6be5bf05ee5f120 Mon Sep 17 00:00:00 2001
From: Steve Nyemba <steve@the-phi.com>
Date: Tue, 17 Sep 2019 11:53:44 -0500
Subject: [PATCH] documentation and housekeeping work

---
 .gitignore |  1 +
 README.md  | 13 ++++++++++++-
 setup.py   | 10 +++++++---
 3 files changed, 20 insertions(+), 4 deletions(-)
 create mode 100644 .gitignore

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..0d20b64
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+*.pyc
diff --git a/README.md b/README.md
index 1913cfe..4e862af 100644
--- a/README.md
+++ b/README.md
@@ -1,12 +1,23 @@
 # Introduction
 
-This project implements an abstraction of objects that can have access to a variety of data stores, implementing read/write functions associated and specific to the data-sources. The classes implement functionalities against :
+This project implements an abstraction of objects that can have access to a variety of data stores, implementing read/write with a simple interface against specific various data-sources. The supported data sources implement functionalities against :
 
     - Rabbitmq-server
     - Couchdb-server
+    - Mongodb-server
     - Http Session : {csv,tab,pipe,sql}
     - Disk{Reader|Writer} : csv, tab, pipe, sql on disk
 
+Such an interface is used to facilitate data transport in and out of a store for whatever an application may need (log, session management, ...)
+
+### Installation
+
+Within the virtual environment perform the following command:
+
+    pip install git+https://dev.the-phi.com/git/steve/data-transport.git
+
+Binaries and eggs will be provided later on
+
 
 ### Usage
 
diff --git a/setup.py b/setup.py
index acd5d78..78ceb07 100644
--- a/setup.py
+++ b/setup.py
@@ -2,7 +2,9 @@
 This is a build file for the 
 """
 from setuptools import setup, find_packages
- 
+import os
+def read(fname):
+    return open(os.path.join(os.path.dirname(__file__), fname)).read() 
 setup(
     name = "data-transport",
     version = "1.0",
@@ -10,10 +12,12 @@ setup(
     author_email = "steve@the-phi.com",
     license = "MIT",
     packages=['transport'],
+    keywords=['mongodb','couchdb','rabbitmq','file','read','write','s3'],
     install_requires = ['pymongo','numpy','cloudant','pika','boto','flask-session','smart_open'],
-
+    url="https://dev.the-phi.com/git/steve/data-transport.git",
     use_2to3=True,
-    convert_2to3_doctests=['src/your/module/README.txt'],
+    long_description=read('README.md'),
+    convert_2to3_doctests=['README.md'],
     use_2to3_fixers=['your.fixers'],
     use_2to3_exclude_fixers=['lib2to3.fixes.fix_import'],
     )