diff --git a/.gitignore b/.gitignore index b1b65ee..eb55227 100644 --- a/.gitignore +++ b/.gitignore @@ -13,4 +13,5 @@ pdwork* .DS_Store camouflage.py config.py -aws/* \ No newline at end of file +aws/* +*.egg-info \ No newline at end of file diff --git a/README.md b/README.md index 839c844..9a68a85 100644 --- a/README.md +++ b/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. = release/v0.0.1) ```bash -$ git clone https://github.com/yoshiki-o0/primely_package.git +$ git clone -b 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 + + +Set your pdf files at `data/input/`. Create a directory if it doesn't exist. + +Run
+```bash +$ python /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/`. Move to the work directory where tarball is set. @@ -59,20 +68,6 @@ Extract the package. $ tar -zxvf ``` -## Running the test -### Analyse your data - -Set your pdf files at `data/input/`. - -Run
-```bash -$ python /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. diff --git a/dist/README.md b/dist/README.md new file mode 100644 index 0000000..d6cfa4a --- /dev/null +++ b/dist/README.md @@ -0,0 +1,7 @@ +## dist + + +To produce a source distribution, invoke: +```bash +$ python setup.py sdist +``` \ No newline at end of file diff --git a/dist/primely_package-0.0.1.tar.gz b/dist/primely_package-0.0.1.tar.gz index 9d56d55..fcf1039 100644 Binary files a/dist/primely_package-0.0.1.tar.gz and b/dist/primely_package-0.0.1.tar.gz differ diff --git a/setup.py b/setup.py index c44eae5..9ec2342 100644 --- a/setup.py +++ b/setup.py @@ -30,5 +30,5 @@ def read_requirements(): 'primely.views', 'tests', ], - test_suite='primely.tests' + test_suite='tests' ) \ No newline at end of file diff --git a/tools/README.md b/tools/README.md new file mode 100644 index 0000000..cf32c28 --- /dev/null +++ b/tools/README.md @@ -0,0 +1,5 @@ +## tools +--- + +### Notice +Scripts located at this directory are not dependent for the primely package itself. \ No newline at end of file