Skip to content

Commit 366799d

Browse files
authored
Read me installation (#3)
* Stable Version - 1.0.1 * Version Update * Added Installation Instruction * Ignore pycache * Added Installation instruction
1 parent 94830ec commit 366799d

File tree

2 files changed

+59
-0
lines changed

2 files changed

+59
-0
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@
22
/dist/
33
/build/
44
/*.egg-info/
5+
**/__pycache__/

READMe.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
[![image](https://i.imgur.com/YIHmXue.png?1)](https://extracttable.com?ref=github-ET)
2+
3+
**Latest verions: 1.0.1** [![image](https://img.shields.io/github/license/ExtractTable/ExtractTable-py)]() [![image](https://img.shields.io/badge/python-3.5%20%7C%203.6%20%7C%203.7-blue)]()
4+
5+
# Overview
6+
[ExtractTable](https://extracttable.com) - **API to extract tabular data from images and scanned PDFs**
7+
8+
The motivation is to make it easy for developers to extract tabular data from images or scanned PDF files without worrying about the table area, column coordinates, rotation et al.
9+
10+
# Prerequisite
11+
12+
Before we talk/boast about the service, a developer MUST need an API key to use the ExtractTable service. [FREE credits here](https://extracttable.com/trail.html).
13+
14+
We beat this market **not just in accuracy also in cost, and expiration**. You are most welcomed to [BUY credits here](https://extracttable.com/#pricing) or email me at saradhi@extracttable.com for assistance.
15+
16+
17+
# Installation
18+
19+
`pip install -U ExtractTable`
20+
21+
22+
# Basic Usage
23+
Ok, enough selling. Let the ease in coding do the talk, and the output encourages you to buy credits - put that timer on and count the LOC.
24+
25+
```python
26+
from ExtractTable import ExtractTable
27+
et_sess = ExtractTable(api_key=YOUR_API_KEY) # Replace your VALID API Key here
28+
print(et_sess.check_usage()) # Checks the API Key validity as well as shows associated plan usage
29+
table_data = et_sess.process_file(filepath=Location_of_Image_with_Tables, output_format="df")
30+
```
31+
[Detail Code Here](ExampleCode.ipynb)
32+
33+
34+
### Woahh, as simple as that ?!
35+
36+
Certainly. Do you know the current ExtractTable users use it on
37+
- Bank Statement
38+
- Medical Records
39+
- Invoice Details
40+
- Tax forms
41+
42+
Its up to you now to explore the ways.
43+
44+
45+
# Explore
46+
**Whatelse** is in the store.
47+
- `ExtractTable._OUTPUT` - check the list of **available output formats**
48+
- `et_sess.ServerResponse.json()` - check the latest Actual **ServerResponse** attached to the session
49+
50+
51+
## Pull Requests & Rewards
52+
53+
Pull requests are most welcome and greatly appreciated.
54+
55+
56+
## License
57+
58+
This project is licensed under the GNU-3.0 License, see the [LICENSE](https://github.com/extracttable/camelotpro/blob/master/LICENSE) file for details.

0 commit comments

Comments
 (0)