parent
9c4e7bf3f6
commit
7731497a5b
|
|
@ -2,7 +2,7 @@
|
||||||
|
|
||||||
If you're reading this, you're probably looking to contributing to Camelot. *Time is the only real currency*, and the fact that you're considering spending some here is *very* generous of you. Thank you very much!
|
If you're reading this, you're probably looking to contributing to Camelot. *Time is the only real currency*, and the fact that you're considering spending some here is *very* generous of you. Thank you very much!
|
||||||
|
|
||||||
This document will help you get started with contributing documentation, code, testing and filing issues. If you have any questions, feel free to reach out to [Vinayak Mehta](http://vinayak-mehta.github.io), the author and maintainer.
|
This document will help you get started with contributing documentation, code, testing and filing issues. If you have any questions, feel free to reach out to [Vinayak Mehta](https://vinayak-mehta.github.io), the author and maintainer.
|
||||||
|
|
||||||
## Code Of Conduct
|
## Code Of Conduct
|
||||||
|
|
||||||
|
|
|
||||||
14
README.md
14
README.md
|
|
@ -4,11 +4,11 @@
|
||||||
|
|
||||||
**Camelot** is a Python library which makes it easy for *anyone* to extract tables from PDF files!
|
**Camelot** is a Python library which makes it easy for *anyone* to extract tables from PDF files!
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
**Here's how you can extract tables from PDF files.** Check out the PDF used in this example, [here](docs/_static/pdf/foo.pdf).
|
**Here's how you can extract tables from PDF files.** Check out the PDF used in this example, [here](https://github.com/socialcopsdev/camelot/blob/master/docs/_static/pdf/foo.pdf).
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
>>> import camelot
|
>>> import camelot
|
||||||
|
|
@ -38,7 +38,7 @@
|
||||||
| 2032_2 | 0.17 | 57.8 | 21.7% | 0.3% | 2.7% | 1.2% |
|
| 2032_2 | 0.17 | 57.8 | 21.7% | 0.3% | 2.7% | 1.2% |
|
||||||
| 4171_1 | 0.07 | 173.9 | 58.1% | 1.6% | 2.1% | 0.5% |
|
| 4171_1 | 0.07 | 173.9 | 58.1% | 1.6% | 2.1% | 0.5% |
|
||||||
|
|
||||||
There's a [command-line interface](http://camelot-py.readthedocs.io/en/master/user/cli.html) too!
|
There's a [command-line interface](https://camelot-py.readthedocs.io/en/latest/user/cli.html) too!
|
||||||
|
|
||||||
## Why Camelot?
|
## Why Camelot?
|
||||||
|
|
||||||
|
|
@ -51,7 +51,7 @@ See [comparison with other PDF table extraction libraries and tools](https://git
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
After [installing the dependencies](http://camelot-py.readthedocs.io/en/master/user/install.html), [tk](https://packages.ubuntu.com/trusty/python-tk) and [ghostscript](https://www.ghostscript.com/), you can simply use pip to install Camelot:
|
After [installing the dependencies](https://camelot-py.readthedocs.io/en/latest/user/install.html) ([tk](https://packages.ubuntu.com/trusty/python-tk) and [ghostscript](https://www.ghostscript.com/)), you can simply use pip to install Camelot:
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
$ pip install camelot-py
|
$ pip install camelot-py
|
||||||
|
|
@ -59,7 +59,7 @@ $ pip install camelot-py
|
||||||
|
|
||||||
### Alternatively
|
### Alternatively
|
||||||
|
|
||||||
After [installing the dependencies](http://camelot-py.readthedocs.io/en/master/user/install.html), clone the repo using:
|
After [installing the dependencies](https://camelot-py.readthedocs.io/en/latest/user/install.html), clone the repo using:
|
||||||
|
|
||||||
<pre>
|
<pre>
|
||||||
$ git clone https://www.github.com/socialcopsdev/camelot
|
$ git clone https://www.github.com/socialcopsdev/camelot
|
||||||
|
|
@ -80,7 +80,7 @@ Great documentation is available at [http://camelot-py.readthedocs.io/](http://c
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|
||||||
The [Contributor's Guide](CONTRIBUTING.md) has detailed information about contributing code, documentation, tests and more. We've included some basic information in this README.
|
The [Contributor's Guide](https://camelot-py.readthedocs.io/en/latest/dev/contributing.html) has detailed information about contributing code, documentation, tests and more. We've included some basic information in this README.
|
||||||
|
|
||||||
### Source code
|
### Source code
|
||||||
|
|
||||||
|
|
@ -112,4 +112,4 @@ Camelot uses [Semantic Versioning](https://semver.org/). For the available versi
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
This project is licensed under the MIT License, see the [LICENSE](LICENSE) file for details.
|
This project is licensed under the MIT License, see the [LICENSE](https://github.com/socialcopsdev/camelot/blob/master/LICENSE) file for details.
|
||||||
|
|
@ -1,6 +1,6 @@
|
||||||
# -*- coding: utf-8 -*-
|
# -*- coding: utf-8 -*-
|
||||||
|
|
||||||
VERSION = (0, 1, 0)
|
VERSION = (0, 1, 1)
|
||||||
|
|
||||||
__title__ = 'camelot-py'
|
__title__ = 'camelot-py'
|
||||||
__description__ = 'PDF Table Extraction for Humans.'
|
__description__ = 'PDF Table Extraction for Humans.'
|
||||||
|
|
|
||||||
|
|
@ -1,5 +1,5 @@
|
||||||
<style type="text/css">
|
<style type="text/css">
|
||||||
div.section h1 {font-size: 225%;}
|
div.section h1 {font-size: 210%;}
|
||||||
/* "Quick Search" should be capitalized. */
|
/* "Quick Search" should be capitalized. */
|
||||||
div#searchbox h3 {text-transform: capitalize;}
|
div#searchbox h3 {text-transform: capitalize;}
|
||||||
/* Make the document a little wider, less code is cut-off. */
|
/* Make the document a little wider, less code is cut-off. */
|
||||||
|
|
|
||||||
|
|
@ -7,7 +7,7 @@ If you're reading this, you're probably looking to contributing to Camelot. *Tim
|
||||||
|
|
||||||
This document will help you get started with contributing documentation, code, testing and filing issues. If you have any questions, feel free to reach out to `Vinayak Mehta`_, the author and maintainer.
|
This document will help you get started with contributing documentation, code, testing and filing issues. If you have any questions, feel free to reach out to `Vinayak Mehta`_, the author and maintainer.
|
||||||
|
|
||||||
.. _Vinayak Mehta: http://vinayak-mehta.github.io
|
.. _Vinayak Mehta: https://vinayak-mehta.github.io
|
||||||
|
|
||||||
Code Of Conduct
|
Code Of Conduct
|
||||||
---------------
|
---------------
|
||||||
|
|
|
||||||
|
|
@ -61,7 +61,6 @@ Why Camelot?
|
||||||
- **Metrics**: *Bad* tables can be discarded based on metrics like accuracy and whitespace, without ever having to manually look at each table.
|
- **Metrics**: *Bad* tables can be discarded based on metrics like accuracy and whitespace, without ever having to manually look at each table.
|
||||||
- Each table is a **pandas DataFrame**, which enables seamless integration into `ETL and data analysis workflows`_.
|
- Each table is a **pandas DataFrame**, which enables seamless integration into `ETL and data analysis workflows`_.
|
||||||
- **Export** to multiple formats, including json, excel and html.
|
- **Export** to multiple formats, including json, excel and html.
|
||||||
- Simple and Elegant API, written in **Python**!
|
|
||||||
|
|
||||||
See `comparison with other PDF table extraction libraries and tools`_.
|
See `comparison with other PDF table extraction libraries and tools`_.
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue