Skip to content
This repository was archived by the owner on Jan 6, 2025. It is now read-only.

Commit b8c5538

Browse files
committed
Update docs
1 parent 0f8cda4 commit b8c5538

10 files changed

+34
-34
lines changed

CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ As the [Requests Code Of Conduct](http://docs.python-requests.org/en/master/dev/
1616

1717
## Your first contribution
1818

19-
A great way to start contributing to Camelot is to pick an issue tagged with the [help wanted](https://github.com/socialcopsdev/camelot/labels/help%20wanted) tag or the [good first issue](https://github.com/socialcopsdev/camelot/labels/good%20first%20issue) tag. If you're unable to find a good first issue, feel free to contact the maintainer.
19+
A great way to start contributing to Camelot is to pick an issue tagged with the [help wanted](https://github.com/camelot-dev/camelot/labels/help%20wanted) tag or the [good first issue](https://github.com/camelot-dev/camelot/labels/good%20first%20issue) tag. If you're unable to find a good first issue, feel free to contact the maintainer.
2020

2121
## Setting up a development environment
2222

@@ -36,7 +36,7 @@ $ pip install ".[dev]"
3636

3737
### Submit a pull request
3838

39-
The preferred workflow for contributing to Camelot is to fork the [project repository](https://github.com/socialcopsdev/camelot) on GitHub, clone, develop on a branch and then finally submit a pull request. Here are the steps:
39+
The preferred workflow for contributing to Camelot is to fork the [project repository](https://github.com/camelot-dev/camelot) on GitHub, clone, develop on a branch and then finally submit a pull request. Here are the steps:
4040

4141
1. Fork the project repository. Click on the ‘Fork’ button near the top of the page. This creates a copy of the code under your account on the GitHub.
4242

@@ -106,7 +106,7 @@ The function docstrings are written using the [numpydoc](https://numpydoc.readth
106106

107107
## Filing Issues
108108

109-
We use [GitHub issues](https://github.com/socialcopsdev/camelot/issues) to keep track of all issues and pull requests. Before opening an issue (which asks a question or reports a bug), please use GitHub search to look for existing issues (both open and closed) that may be similar.
109+
We use [GitHub issues](https://github.com/camelot-dev/camelot/issues) to keep track of all issues and pull requests. Before opening an issue (which asks a question or reports a bug), please use GitHub search to look for existing issues (both open and closed) that may be similar.
110110

111111
### Questions
112112

README.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616

1717
---
1818

19-
**Here's how you can extract tables from PDF files.** Check out the PDF used in this example [here](https://github.com/atlanhq/camelot/blob/master/docs/_static/pdf/foo.pdf).
19+
**Here's how you can extract tables from PDF files.** Check out the PDF used in this example [here](https://github.com/camelot-dev/camelot/blob/master/docs/_static/pdf/foo.pdf).
2020

2121
<pre>
2222
>>> import camelot
@@ -57,7 +57,7 @@ There's a [command-line interface](https://camelot-py.readthedocs.io/en/master/u
5757
- Each table is a **pandas DataFrame**, which seamlessly integrates into [ETL and data analysis workflows](https://gist.github.com/vinayak-mehta/e5949f7c2410a0e12f25d3682dc9e873).
5858
- **Export** to multiple formats, including JSON, Excel, HTML and Sqlite.
5959

60-
See [comparison with other PDF table extraction libraries and tools](https://github.com/atlanhq/camelot/wiki/Comparison-with-other-PDF-Table-Extraction-libraries-and-tools).
60+
See [comparison with other PDF table extraction libraries and tools](https://github.com/camelot-dev/camelot/wiki/Comparison-with-other-PDF-Table-Extraction-libraries-and-tools).
6161

6262
## Installation
6363

@@ -82,7 +82,7 @@ $ pip install camelot-py[cv]
8282
After [installing the dependencies](https://camelot-py.readthedocs.io/en/master/user/install.html#using-pip), clone the repo using:
8383

8484
<pre>
85-
$ git clone https://www.github.com/atlanhq/camelot
85+
$ git clone https://www.github.com/camelot-dev/camelot
8686
</pre>
8787

8888
and install Camelot using pip:
@@ -105,7 +105,7 @@ The [Contributor's Guide](https://camelot-py.readthedocs.io/en/master/dev/contri
105105
You can check the latest sources with:
106106

107107
<pre>
108-
$ git clone https://www.github.com/atlanhq/camelot
108+
$ git clone https://www.github.com/camelot-dev/camelot
109109
</pre>
110110

111111
### Setting up a development environment
@@ -126,10 +126,10 @@ $ python setup.py test
126126

127127
## Versioning
128128

129-
Camelot uses [Semantic Versioning](https://semver.org/). For the available versions, see the tags on this repository. For the changelog, you can check out [HISTORY.md](https://github.com/atlanhq/camelot/blob/master/HISTORY.md).
129+
Camelot uses [Semantic Versioning](https://semver.org/). For the available versions, see the tags on this repository. For the changelog, you can check out [HISTORY.md](https://github.com/camelot-dev/camelot/blob/master/HISTORY.md).
130130

131131
## License
132132

133-
This project is licensed under the MIT License, see the [LICENSE](https://github.com/atlanhq/camelot/blob/master/LICENSE) file for details.
133+
This project is licensed under the MIT License, see the [LICENSE](https://github.com/camelot-dev/camelot/blob/master/LICENSE) file for details.
134134

135135
<img src="http://i65.tinypic.com/9h4ajs.png" align="centre" />

docs/_templates/sidebarintro.html

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
</a>
55
</p>
66
<p>
7-
<iframe src="https://ghbtns.com/github-btn.html?user=socialcopsdev&repo=camelot&type=watch&count=true&size=large"
7+
<iframe src="https://ghbtns.com/github-btn.html?user=camelot-dev&repo=camelot&type=watch&count=true&size=large"
88
allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
99
</p>
1010

1111
<h3>Useful Links</h3>
1212
<ul>
13-
<li><a href="https://github.com/socialcopsdev/camelot">Camelot @ GitHub</a></li>
13+
<li><a href="https://github.com/camelot-dev/camelot">Camelot @ GitHub</a></li>
1414
<li><a href="https://pypi.org/project/camelot-py/">Camelot @ PyPI</a></li>
15-
<li><a href="https://github.com/socialcopsdev/camelot/issues">Issue Tracker</a></li>
16-
</ul>
15+
<li><a href="https://github.com/camelot-dev/camelot/issues">Issue Tracker</a></li>
16+
</ul>

docs/_templates/sidebarlogo.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@
44
</a>
55
</p>
66
<p>
7-
<iframe src="https://ghbtns.com/github-btn.html?user=socialcopsdev&repo=camelot&type=watch&count=true&size=large"
7+
<iframe src="https://ghbtns.com/github-btn.html?user=camelot-dev&repo=camelot&type=watch&count=true&size=large"
88
allowtransparency="true" frameborder="0" scrolling="0" width="200px" height="35px"></iframe>
9-
</p>
9+
</p>

docs/conf.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@
6363

6464
# General information about the project.
6565
project = u'Camelot'
66-
copyright = u'2018, <a href="https://socialcops.com" target="_blank">SocialCops</a>'
66+
copyright = u'2019, Camelot Developers'
6767
author = u'Vinayak Mehta'
6868

6969
# The version info for the project you're documenting, acts as replacement for
@@ -137,7 +137,7 @@
137137
# documentation.
138138
html_theme_options = {
139139
'show_powered_by': False,
140-
'github_user': 'socialcopsdev',
140+
'github_user': 'camelot-dev',
141141
'github_repo': 'camelot',
142142
'github_banner': True,
143143
'show_related': False,

docs/dev/contributing.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ Your first contribution
2929

3030
A great way to start contributing to Camelot is to pick an issue tagged with the `help wanted`_ or the `good first issue`_ tags. If you're unable to find a good first issue, feel free to contact the maintainer.
3131

32-
.. _help wanted: https://github.com/socialcopsdev/camelot/labels/help%20wanted
33-
.. _good first issue: https://github.com/socialcopsdev/camelot/labels/good%20first%20issue
32+
.. _help wanted: https://github.com/camelot-dev/camelot/labels/help%20wanted
33+
.. _good first issue: https://github.com/camelot-dev/camelot/labels/good%20first%20issue
3434

3535
Setting up a development environment
3636
------------------------------------
@@ -51,7 +51,7 @@ Submit a pull request
5151

5252
The preferred workflow for contributing to Camelot is to fork the `project repository`_ on GitHub, clone, develop on a branch and then finally submit a pull request. Here are the steps:
5353

54-
.. _project repository: https://github.com/socialcopsdev/camelot
54+
.. _project repository: https://github.com/camelot-dev/camelot
5555

5656
1. Fork the project repository. Click on the ‘Fork’ button near the top of the page. This creates a copy of the code under your account on the GitHub.
5757

@@ -134,7 +134,7 @@ Filing Issues
134134

135135
We use `GitHub issues`_ to keep track of all issues and pull requests. Before opening an issue (which asks a question or reports a bug), please use GitHub search to look for existing issues (both open and closed) that may be similar.
136136

137-
.. _GitHub issues: https://github.com/socialcopsdev/camelot/issues
137+
.. _GitHub issues: https://github.com/camelot-dev/camelot/issues
138138

139139
Questions
140140
^^^^^^^^^

docs/index.rst

+5-5
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,15 @@ Camelot: PDF Table Extraction for Humans
88

99
Release v\ |version|. (:ref:`Installation <install>`)
1010

11-
.. image:: https://travis-ci.org/socialcopsdev/camelot.svg?branch=master
12-
:target: https://travis-ci.org/socialcopsdev/camelot
11+
.. image:: https://travis-ci.org/camelot-dev/camelot.svg?branch=master
12+
:target: https://travis-ci.org/camelot-dev/camelot
1313

1414
.. image:: https://readthedocs.org/projects/camelot-py/badge/?version=master
1515
:target: https://camelot-py.readthedocs.io/en/master/
1616
:alt: Documentation Status
1717

18-
.. image:: https://codecov.io/github/socialcopsdev/camelot/badge.svg?branch=master&service=github
19-
:target: https://codecov.io/github/socialcopsdev/camelot?branch=master
18+
.. image:: https://codecov.io/github/camelot-dev/camelot/badge.svg?branch=master&service=github
19+
:target: https://codecov.io/github/camelot-dev/camelot?branch=master
2020

2121
.. image:: https://img.shields.io/pypi/v/camelot-py.svg
2222
:target: https://pypi.org/project/camelot-py/
@@ -81,7 +81,7 @@ Why Camelot?
8181
See `comparison with other PDF table extraction libraries and tools`_.
8282

8383
.. _ETL and data analysis workflows: https://gist.github.com/vinayak-mehta/e5949f7c2410a0e12f25d3682dc9e873
84-
.. _comparison with other PDF table extraction libraries and tools: https://github.com/socialcopsdev/camelot/wiki/Comparison-with-other-PDF-Table-Extraction-libraries-and-tools
84+
.. _comparison with other PDF table extraction libraries and tools: https://github.com/camelot-dev/camelot/wiki/Comparison-with-other-PDF-Table-Extraction-libraries-and-tools
8585

8686
The User Guide
8787
--------------

docs/user/advanced.rst

+6-6
Original file line numberDiff line numberDiff line change
@@ -224,12 +224,12 @@ Table areas that you want Camelot to analyze can be passed as a list of comma-se
224224
.. csv-table::
225225
:file: ../_static/csv/table_areas.csv
226226

227-
.. note:: ``table_areas`` accepts strings of the form x1,y1,x2,y2 where (x1, y1) -> top-left and (x2, y2) -> bottom-right in PDF coordinate space. In PDF coordinate space, the bottom-left corner of the page is the origin, with coordinates (0, 0).
227+
.. note:: ``table_areas`` accepts strings of the form x1,y1,x2,y2 where (x1, y1) -> top-left and (x2, y2) -> bottom-right in PDF coordinate space. In PDF coordinate space, the bottom-left corner of the page is the origin, with coordinates (0, 0).
228228

229229
Specify table regions
230230
---------------------
231231

232-
However there may be cases like `[1] <../_static/pdf/table_regions.pdf>`__ and `[2] <https://github.com/socialcopsdev/camelot/blob/master/tests/files/tableception.pdf>`__, where the table might not lie at the exact coordinates every time but in an approximate region.
232+
However there may be cases like `[1] <../_static/pdf/table_regions.pdf>`__ and `[2] <https://github.com/camelot-dev/camelot/blob/master/tests/files/tableception.pdf>`__, where the table might not lie at the exact coordinates every time but in an approximate region.
233233

234234
You can use the ``table_regions`` keyword argument to :meth:`read_pdf() <camelot.read_pdf>` to solve for such cases. When ``table_regions`` is specified, Camelot will only analyze the specified regions to look for tables.
235235

@@ -316,7 +316,7 @@ In this case, the text that `other tools`_ return, will be ``24.912``. This is r
316316

317317
You can solve this by passing ``flag_size=True``, which will enclose the superscripts and subscripts with ``<s></s>``, based on font size, as shown below.
318318

319-
.. _other tools: https://github.com/socialcopsdev/camelot/wiki/Comparison-with-other-PDF-Table-Extraction-libraries-and-tools
319+
.. _other tools: https://github.com/camelot-dev/camelot/wiki/Comparison-with-other-PDF-Table-Extraction-libraries-and-tools
320320

321321
::
322322

@@ -340,7 +340,7 @@ You can solve this by passing ``flag_size=True``, which will enclose the supersc
340340
Strip characters from text
341341
--------------------------
342342

343-
You can strip unwanted characters like spaces, dots and newlines from a string using the ``strip_text`` keyword argument. Take a look at `this PDF <https://github.com/socialcopsdev/camelot/blob/master/tests/files/tabula/12s0324.pdf>`_ as an example, the text at the start of each row contains a lot of unwanted spaces, dots and newlines.
343+
You can strip unwanted characters like spaces, dots and newlines from a string using the ``strip_text`` keyword argument. Take a look at `this PDF <https://github.com/camelot-dev/camelot/blob/master/tests/files/tabula/12s0324.pdf>`_ as an example, the text at the start of each row contains a lot of unwanted spaces, dots and newlines.
344344

345345
::
346346

@@ -366,7 +366,7 @@ You can strip unwanted characters like spaces, dots and newlines from a string u
366366
Improve guessed table areas
367367
---------------------------
368368

369-
While using :ref:`Stream <stream>`, automatic table detection can fail for PDFs like `this one <https://github.com/socialcopsdev/camelot/blob/master/tests/files/edge_tol.pdf>`_. That's because the text is relatively far apart vertically, which can lead to shorter textedges being calculated.
369+
While using :ref:`Stream <stream>`, automatic table detection can fail for PDFs like `this one <https://github.com/camelot-dev/camelot/blob/master/tests/files/edge_tol.pdf>`_. That's because the text is relatively far apart vertically, which can lead to shorter textedges being calculated.
370370

371371
.. note:: To know more about how textedges are calculated to guess table areas, you can see pages 20, 35 and 40 of `Anssi Nurminen's master's thesis <http://dspace.cc.tut.fi/dpub/bitstream/handle/123456789/21520/Nurminen.pdf?sequence=3>`_.
372372

@@ -626,7 +626,7 @@ We don't need anything else. Now, let's pass ``copy_text=['v']`` to copy text in
626626
Tweak layout generation
627627
-----------------------
628628

629-
Camelot is built on top of PDFMiner's functionality of grouping characters on a page into words and sentences. In some cases (such as `#170 <https://github.com/socialcopsdev/camelot/issues/170>`_ and `#215 <https://github.com/socialcopsdev/camelot/issues/215>`_), PDFMiner can group characters that should belong to the same sentence into separate sentences.
629+
Camelot is built on top of PDFMiner's functionality of grouping characters on a page into words and sentences. In some cases (such as `#170 <https://github.com/camelot-dev/camelot/issues/170>`_ and `#215 <https://github.com/camelot-dev/camelot/issues/215>`_), PDFMiner can group characters that should belong to the same sentence into separate sentences.
630630

631631
To deal with such cases, you can tweak PDFMiner's `LAParams kwargs <https://github.com/euske/pdfminer/blob/master/pdfminer/layout.py#L33>`_ to improve layout generation, by passing the keyword arguments as a dict using ``layout_kwargs`` in :meth:`read_pdf() <camelot.read_pdf>`. To know more about the parameters you can tweak, you can check out `PDFMiner docs <https://euske.github.io/pdfminer/>`_.
632632

docs/user/install.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ After :ref:`installing the dependencies <install_deps>`, you can install from th
3838
1. Cloning the GitHub repository.
3939
::
4040

41-
$ git clone https://www.github.com/socialcopsdev/camelot
41+
$ git clone https://www.github.com/camelot-dev/camelot
4242

4343
2. Then simply using pip again.
4444
::

docs/user/intro.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ Here is a `comparison`_ of Camelot's output with outputs from other open-source
2727
.. _pdf-table-extract: https://github.com/ashima/pdf-table-extract
2828
.. _PDFTables: https://pdftables.com/
2929
.. _Smallpdf: https://smallpdf.com
30-
.. _comparison: https://github.com/socialcopsdev/camelot/wiki/Comparison-with-other-PDF-Table-Extraction-libraries-and-tools
30+
.. _comparison: https://github.com/camelot-dev/camelot/wiki/Comparison-with-other-PDF-Table-Extraction-libraries-and-tools
3131

3232
What's in a name?
3333
-----------------

0 commit comments

Comments
 (0)