Merge branch 'develop' into release/v0.0.1

.gitignore

@@ -13,4 +13,5 @@ pdwork*
 .DS_Store
 camouflage.py
 config.py
-aws/*
+aws/*
+*.egg-info

README.md

@@ -19,14 +19,9 @@ This package can provide a json response where a series of paychecks are organiz
 
 
 ### Installing
-There's two way you could use this package.
-1. Git clone this repository.
-2. Extract from tarball.
-
-#### 1. Git clone
-Git clone this package.
+Git clone the latest repository. (e.g. <branch_name> = release/v0.0.1)
 ```bash
-$ git clone https://github.com/yoshiki-o0/primely_package.git
+$ git clone -b <branch_name> https://github.com/yoshiki-o0/primely_package.git
 ```
 
 Move to the home directory of the package.
@@ -45,8 +40,22 @@ Install dependent packages.
 $ pip install --upgrade -r requirements.txt
 ```
 
+### Running the test
+<!-- ### Process your data -->
+
+Set your pdf files at `data/input/`. Create a directory if it doesn't exist.
+
+Run <br>
+```bash
+$ python <package_home_dir_path>/main.py
+```
+
+### Check your json
+If the process completes successfully, the json response will be extracted under `data/output/json/`.
+
 
-#### 2. Extract from tarball
+## Utilize as a package
+### Extract from tarball
 Download tarball from `primely_package/dist/<package_name>`.
 
 Move to the work directory where tarball is set.
@@ -59,20 +68,6 @@ Extract the package.
 $ tar -zxvf <package_name>
 ```
 
-## Running the test
-### Analyse your data
-
-Set your pdf files at `data/input/`.
-
-Run <br>
-```bash
-$ python <package_home_dir_path>/main.py
-```
-
-### Check your json
-If the process completes successfully, the json response could be checked at `data/output/json/paycheck_timechart.json`.
-
-
 ## Built With
 * [pdfminor.six](https://github.com/pdfminer/pdfminer.six) - Used to extract text from pdf files.
 

dist/README.md

@@ -0,0 +1,7 @@
+## dist
+
+
+To produce a source distribution, invoke:
+```bash
+$ python setup.py sdist
+```

setup.py

@@ -30,5 +30,5 @@ def read_requirements():
         'primely.views',
         'tests',
     ],
-    test_suite='primely.tests'
+    test_suite='tests'
 )

tools/README.md

@@ -0,0 +1,5 @@
+## tools
+---
+
+### Notice
+Scripts located at this directory are not dependent for the primely package itself.