invoice2data 0.4.5__tar.gz → 0.4.7__tar.gz

{invoice2data-0.4.5/src/invoice2data.egg-info → invoice2data-0.4.7}/PKG-INFO

@@ -1,47 +1,85 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: invoice2data
-Version: 0.4.5
+Version: 0.4.7
 Summary: Python parser to extract data from pdf invoice
-Home-page: https://github.com/invoice-x/invoice2data
 Author: Manuel Riel
-License: MIT License
-Keywords: pdf,invoicing
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Environment :: MacOS X
-Classifier: Environment :: Console
-Classifier: Environment :: Win32 (MS Windows)
-Classifier: Operating System :: MacOS
-Classifier: Operating System :: POSIX
-Classifier: Operating System :: Unix
-Classifier: Operating System :: Microsoft :: Windows
+License: MIT
+Project-URL: homepage, https://github.com/invoice-x/invoice2data
+Project-URL: repository, https://github.com/invoice-x/invoice2data
+Project-URL: documentation, https://invoice2data.readthedocs.io
+Project-URL: Changelog, https://github.com/invoice-x/invoice2data/releases
+Keywords: python,data-mining,accounting,invoice,pdf,parcing
+Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
+Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Office/Business :: Financial
 Classifier: Topic :: Office/Business :: Financial :: Accounting
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Office/Business :: Financial :: Accounting
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Development Status :: 5 - Production/Stable
+Requires-Python: >=3.9
 Description-Content-Type: text/markdown
-Requires-Dist: pillow
-Requires-Dist: pyyaml
-Requires-Dist: dateparser
-Provides-Extra: test
-Requires-Dist: pytest; extra == "test"
-Requires-Dist: pytest-cov; extra == "test"
-Requires-Dist: flake8; extra == "test"
-Requires-Dist: pdfminer.six; extra == "test"
-Requires-Dist: pdfplumber; extra == "test"
-Requires-Dist: tox; extra == "test"
+License-File: LICENSE.md
+Requires-Dist: click>=8.0.1
+Requires-Dist: dateparser>=1.2.0
+Requires-Dist: PyYAML>=6.0
+Requires-Dist: regex>=2025.2.10; python_version >= "3.12"
+Requires-Dist: regex>=2024.4.16; python_version < "3.12"
+Provides-Extra: defusedxml
+Requires-Dist: defusedxml==0.7.1; extra == "defusedxml"
+Provides-Extra: googlevision
+Requires-Dist: google-cloud-storage==2.18.2; extra == "googlevision"
+Requires-Dist: google-cloud-vision==3.8.1; extra == "googlevision"
+Provides-Extra: ocr
+Requires-Dist: ghostscript==0.7; extra == "ocr"
+Provides-Extra: ocrmypdf
+Requires-Dist: ocrmypdf>=14.4.0; extra == "ocrmypdf"
+Provides-Extra: pdfminer-six
+Requires-Dist: pdfminer-six==20231228; extra == "pdfminer-six"
+Provides-Extra: pdfplumber
+Requires-Dist: pdfplumber==0.11.4; extra == "pdfplumber"
+Provides-Extra: pyyaml
+Requires-Dist: pyyaml==6.0.2; extra == "pyyaml"
+Dynamic: license-file
 
 # Data extractor for PDF invoices - invoice2data
 
+[![Read the documentation at https://invoice2data.readthedocs.io/](https://img.shields.io/readthedocs/invoice2data/latest.svg?label=Read%20the%20Docs)][read the docs]
 [![invoice2data build status on GitHub Actions](https://github.com/invoice-x/invoice2data/workflows/Test/badge.svg)](https://github.com/invoice-x/invoice2data/actions)
 [![Version](https://img.shields.io/pypi/v/invoice2data.svg)](https://pypi.python.org/pypi/invoice2data)
 [![Support Python versions](https://img.shields.io/pypi/pyversions/invoice2data.svg)](https://pypi.python.org/pypi/invoice2data)
-
-A command line tool and Python library to support your accounting
-process.
+[![License](https://img.shields.io/pypi/l/invoice2data)][license]
+[![Tests](https://github.com/invoice-x/invoice2data/workflows/Tests/badge.svg)][tests]
+[![Codecov](https://codecov.io/gh/invoice-x/invoice2data/branch/main/graph/badge.svg)][codecov]
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+[pypi status]: https://pypi.org/project/invoice2data/
+[read the docs]: https://invoice2data.readthedocs.io/
+[tests]: https://github.com/invoice-x/invoice2data/actions?workflow=Tests
+[codecov]: https://app.codecov.io/gh/invoice-x/invoice2data
+[pre-commit]: https://github.com/pre-commit/pre-commit
+[ruff badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+[ruff project]: https://github.com/charliermarsh/ruff
+
+A command line tool and Python library that automates the extraction of key information from invoices to support your accounting
+process. The library is very flexible and can be used on other types of business documents as well.
+
+In essence, invoice2data simplifies the process of getting data from invoices by:
+
+Automating text extraction: No more manual copying and pasting.
+Using templates for structure: Handles different invoice layouts.
+Providing structured output: Makes the data ready for analysis or further processing.
+This makes it a valuable tool for businesses and developers dealing with a large volume of invoices, saving time and reducing errors associated with manual data entry.
 
 1. extracts text from PDF files using different techniques, like
    `pdftotext`, `text`, `ocrmypdf`, `pdfminer`, `pdfplumber` or OCR -- `tesseract`, or
@@ -67,92 +105,11 @@ Go from PDF files to this:
     {'date': (2014, 8, 3), 'invoice_number': '42183017', 'amount': 4.11, 'desc': 'Invoice 42183017 from Amazon Web Services'}
     {'date': (2015, 1, 28), 'invoice_number': '12429647', 'amount': 101.0, 'desc': 'Invoice 12429647 from Envato'}
 
-```mermaid
-flowchart LR
-
-    InvoiceFile[fa:fa-file-invoice Invoicefile\n\npdf\nimage\ntext] --> Input-module(Input Module\n\npdftotext\ntext\npdfminer\npdfplumber\ntesseract\ngvision)
-
-    Input-module --> |Extracted Text| C{keyword\nmatching}
-
-    Invoice-Templates[(fa:fa-file-lines Invoice Templates)] --> C{keyword\nmatching}
-
-    C --> |Extracted Text + fa:fa-file-circle-check Template| E(Template Processing\n apply options from template\nremove accents, replaces etc...)
-
-    E --> |Optimized String|Plugins&Parsers(Call plugins + parsers)
-
-    subgraph Plugins&Parsers
-
-      direction BT
-
-        tables[fa:fa-table tables] ~~~ lines[fa:fa-grip-lines lines]
-
-        lines ~~~ regex[fa:fa-code regex]
-
-        regex ~~~ static[fa:fa-check static]
-
- 
-
-    end
-
-    Plugins&Parsers --> |output| result[result\nfa:fa-file-csv,\njson,\nXML]
-
- 
-
- click Invoice-Templates https://github.com/invoice-x/invoice2data/blob/master/TUTORIAL.md
-
- click result https://github.com/invoice-x/invoice2data#usage
-
- click Input-module https://github.com/invoice-x/invoice2data#installation-of-input-modules
-
- click E https://github.com/invoice-x/invoice2data/blob/master/TUTORIAL.md#options
-
- click tables https://github.com/invoice-x/invoice2data/blob/master/TUTORIAL.md#tables
-
- click lines https://github.com/invoice-x/invoice2data/blob/master/TUTORIAL.md#lines
-
- click regex https://github.com/invoice-x/invoice2data/blob/master/TUTORIAL.md#regex
-
- click static https://github.com/invoice-x/invoice2data/blob/master/TUTORIAL.md#parser-static
-
-```
-
-## Installation
-
-1.  Install pdftotext
-
-If possible get the latest
-[xpdf/poppler-utils](https://poppler.freedesktop.org/) version. It's
-included with macOS Homebrew, Debian and Ubuntu. Without it, `pdftotext`
-won't parse tables in PDF correctly.
-
-2.  Install `invoice2data` using pip
-
-    pip install invoice2data
-
-### Installation of input modules
-
-An [tesseract](https://github.com/tesseract-ocr/tessdoc/blob/main/FAQ.md#how-do-i-get-tesseract) wrapper is included in auto language mode. It will test your input files against the languages installed on your system. To use it tesseract and imagemagick needs to be installed.
-tesseract supports multiple OCR engine modes. By default the available engine installed on the system will be used.
-
-Languages:
-tesseract-ocr recognize more than [100 languages](https://github.com/tesseract-ocr/tessdata)
-For Linux users, you can often find packages that provide language packs:
-
-```
-# Display a list of all Tesseract language packs
-apt-cache search tesseract-ocr
-
-# Debian/Ubuntu users
-apt-get install tesseract-ocr-chi-sim  # Example: Install Chinese Simplified language pack
-
-# Arch Linux users
-pacman -S tesseract-data-eng tesseract-data-deu # Example: Install the English and German language packs
-
-```
 
 ## Usage
 
 Basic usage. Process PDF files and write result to CSV.
+Please see the [Command-line Reference] for details.
 
 - `invoice2data invoice.pdf`
 - `invoice2data invoice.txt`
@@ -166,7 +123,7 @@ Choose any of the following input readers:
 - pdfminer.six `invoice2data --input-reader pdfminer invoice.pdf`
 - pdfplumber `invoice2data --input-reader pdfplumber invoice.pdf`
 - ocrmypdf `invoice2data --input-reader ocrmypdf invoice.pdf`
-- gvision `invoice2data --input-reader gvision invoice.pdf` (needs `GOOGLE_APPLICATION_CREDENTIALS` env var)
+- gvision `invoice2data --input-reader gvision invoice.pdf` (needs `GOOGLE_APPLICATION_CREDENTIALS` env var and a Google Cloud Bucket name. The bucket name can be set as an argument to the function ``to_text`` or as an Environment variable named ``GOOGLE_CLOUD_BUCKET_NAME`` )
 
 Choose any of the following output formats:
 
@@ -216,13 +173,12 @@ Using in-house templates
     templates = read_templates('/path/to/your/templates/')
     result = extract_data(filename, templates=templates)
 
-
 ## Template system
 
 See `invoice2data/extract/templates` for existing templates. Just extend
 the list to add your own. If deployed by a bigger organisation, there
 should be an interface to edit templates for new suppliers. 80-20 rule.
-For a short tutorial on how to add new templates, see [TUTORIAL.md](TUTORIAL.md).
+For a short tutorial on how to add new templates, see [tutorial.md](./docs/tutorial.md).
 
 Templates are based on Yaml or JSON. They define one or more keywords to find
 the right template, one or more exclude_keywords to further narrow it down
@@ -236,6 +192,7 @@ processing.
 
 Example:
 
+````yaml
     issuer: Amazon Web Services, Inc.
     keywords:
     - Amazon Web Services
@@ -259,8 +216,10 @@ Example:
         line: (.*)\$(\d+\.\d+)
         skip_line: Note
         last_line: VAT \*\*
+````
 
 The lines package has multiple settings:
+
 - start > The pattern where the lines begin. This is typically the header row of the table. This row is not included in the line matching.
 - end > The pattern denoting where the lines end. Typically some text at the very end or immediately below the table. Also not included in the line matching.
 - first_line > Optional. This is the primary line item for each entry.
@@ -273,20 +232,20 @@ As an alternative json templates can be used. Which are natively better supporte
 
 The performance with yaml templates can be greatly increased **10x** by using [libyaml](https://github.com/yaml/libyaml)
 It can be installed on most distributions by:
-`sudo apt-get libyaml-dev`
-
+`sudo apt-get install libyaml-dev`
 
 ## Development
 
 If you are interested in improving this project, have a look at our
-[developer guide](DEVELOP.md) to get you started quickly.
+[developer guide](./CONTRIBUTING.md) to get you started quickly.
 
 ## Roadmap and open tasks
 
 - integrate with online OCR?
 - try to 'guess' parameters for new invoice formats.
-- can apply machine learning to guess new parameters?
-- advanced table parsing with [camelot](https://github.com/camelot-dev/camelot)
+- apply machine learning to guess new parameters / template creation
+- Data cleanup per field
+- advanced table parsing with [pypdf_table_extraction](https://github.com/py-pdf/pypdf_table_extraction)
 
 ## Maintainers
 
@@ -294,14 +253,22 @@ If you are interested in improving this project, have a look at our
 - [Alexis de Lattre](https://github.com/alexis-via)
 - [bosd](https://github.com/bosd)
 
-## Contributors
+## Contributors and Credits
+
+- [Harshit Joshi](https://github.com/duskybomb): As Google Summer of
+  Code student.
+- [Holger Brunn](https://github.com/hbrunn): Add support for parsing
+  invoice items.
+
+[pypi]: https://pypi.org/
+[file an issue]: https://github.com/invoice-x/invoice2data/issues
+[pip]: https://pip.pypa.io/
 
--   [Harshit Joshi](https://github.com/duskybomb): As Google Summer of
-    Code student.
--   [Holger Brunn](https://github.com/hbrunn): Add support for parsing
-    invoice items.
+Contributions are very welcome.
+To learn more, see the [Contributor Guide].
 
 ## Used By
+
 - Odoo, OCA module [account_invoice_import_invoice2data](https://github.com/OCA/edi)
 
 ## Related Projects
@@ -314,3 +281,9 @@ If you are interested in improving this project, have a look at our
   (Commercial)
 - [CVision](http://www.cvisiontech.com/library/document-automation/forms-processing/extract-data-from-invoice.html)
   (Commercial)
+
+<!-- github-only -->
+
+[license]: https://invoice2data.readthedocs.io/latest/license.html
+[contributor guide]: https://invoice2data.readthedocs.io/latest/contributing.html
+[command-line reference]: https://invoice2data.readthedocs.io/latest/usage.html

{invoice2data-0.4.5 → invoice2data-0.4.7}/README.md

@@ -1,11 +1,32 @@
 # Data extractor for PDF invoices - invoice2data
 
+[![Read the documentation at https://invoice2data.readthedocs.io/](https://img.shields.io/readthedocs/invoice2data/latest.svg?label=Read%20the%20Docs)][read the docs]
 [![invoice2data build status on GitHub Actions](https://github.com/invoice-x/invoice2data/workflows/Test/badge.svg)](https://github.com/invoice-x/invoice2data/actions)
 [![Version](https://img.shields.io/pypi/v/invoice2data.svg)](https://pypi.python.org/pypi/invoice2data)
 [![Support Python versions](https://img.shields.io/pypi/pyversions/invoice2data.svg)](https://pypi.python.org/pypi/invoice2data)
-
-A command line tool and Python library to support your accounting
-process.
+[![License](https://img.shields.io/pypi/l/invoice2data)][license]
+[![Tests](https://github.com/invoice-x/invoice2data/workflows/Tests/badge.svg)][tests]
+[![Codecov](https://codecov.io/gh/invoice-x/invoice2data/branch/main/graph/badge.svg)][codecov]
+[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)][pre-commit]
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+[pypi status]: https://pypi.org/project/invoice2data/
+[read the docs]: https://invoice2data.readthedocs.io/
+[tests]: https://github.com/invoice-x/invoice2data/actions?workflow=Tests
+[codecov]: https://app.codecov.io/gh/invoice-x/invoice2data
+[pre-commit]: https://github.com/pre-commit/pre-commit
+[ruff badge]: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+[ruff project]: https://github.com/charliermarsh/ruff
+
+A command line tool and Python library that automates the extraction of key information from invoices to support your accounting
+process. The library is very flexible and can be used on other types of business documents as well.
+
+In essence, invoice2data simplifies the process of getting data from invoices by:
+
+Automating text extraction: No more manual copying and pasting.
+Using templates for structure: Handles different invoice layouts.
+Providing structured output: Makes the data ready for analysis or further processing.
+This makes it a valuable tool for businesses and developers dealing with a large volume of invoices, saving time and reducing errors associated with manual data entry.
 
 1. extracts text from PDF files using different techniques, like
    `pdftotext`, `text`, `ocrmypdf`, `pdfminer`, `pdfplumber` or OCR -- `tesseract`, or
@@ -31,92 +52,11 @@ Go from PDF files to this:
     {'date': (2014, 8, 3), 'invoice_number': '42183017', 'amount': 4.11, 'desc': 'Invoice 42183017 from Amazon Web Services'}
     {'date': (2015, 1, 28), 'invoice_number': '12429647', 'amount': 101.0, 'desc': 'Invoice 12429647 from Envato'}
 
-```mermaid
-flowchart LR
-
-    InvoiceFile[fa:fa-file-invoice Invoicefile\n\npdf\nimage\ntext] --> Input-module(Input Module\n\npdftotext\ntext\npdfminer\npdfplumber\ntesseract\ngvision)
-
-    Input-module --> |Extracted Text| C{keyword\nmatching}
-
-    Invoice-Templates[(fa:fa-file-lines Invoice Templates)] --> C{keyword\nmatching}
-
-    C --> |Extracted Text + fa:fa-file-circle-check Template| E(Template Processing\n apply options from template\nremove accents, replaces etc...)
-
-    E --> |Optimized String|Plugins&Parsers(Call plugins + parsers)
-
-    subgraph Plugins&Parsers
-
-      direction BT
-
-        tables[fa:fa-table tables] ~~~ lines[fa:fa-grip-lines lines]
-
-        lines ~~~ regex[fa:fa-code regex]
-
-        regex ~~~ static[fa:fa-check static]
-
- 
-
-    end
-
-    Plugins&Parsers --> |output| result[result\nfa:fa-file-csv,\njson,\nXML]
-
- 
-
- click Invoice-Templates https://github.com/invoice-x/invoice2data/blob/master/TUTORIAL.md
-
- click result https://github.com/invoice-x/invoice2data#usage
-
- click Input-module https://github.com/invoice-x/invoice2data#installation-of-input-modules
-
- click E https://github.com/invoice-x/invoice2data/blob/master/TUTORIAL.md#options
-
- click tables https://github.com/invoice-x/invoice2data/blob/master/TUTORIAL.md#tables
-
- click lines https://github.com/invoice-x/invoice2data/blob/master/TUTORIAL.md#lines
-
- click regex https://github.com/invoice-x/invoice2data/blob/master/TUTORIAL.md#regex
-
- click static https://github.com/invoice-x/invoice2data/blob/master/TUTORIAL.md#parser-static
-
-```
-
-## Installation
-
-1.  Install pdftotext
-
-If possible get the latest
-[xpdf/poppler-utils](https://poppler.freedesktop.org/) version. It's
-included with macOS Homebrew, Debian and Ubuntu. Without it, `pdftotext`
-won't parse tables in PDF correctly.
-
-2.  Install `invoice2data` using pip
-
-    pip install invoice2data
-
-### Installation of input modules
-
-An [tesseract](https://github.com/tesseract-ocr/tessdoc/blob/main/FAQ.md#how-do-i-get-tesseract) wrapper is included in auto language mode. It will test your input files against the languages installed on your system. To use it tesseract and imagemagick needs to be installed.
-tesseract supports multiple OCR engine modes. By default the available engine installed on the system will be used.
-
-Languages:
-tesseract-ocr recognize more than [100 languages](https://github.com/tesseract-ocr/tessdata)
-For Linux users, you can often find packages that provide language packs:
-
-```
-# Display a list of all Tesseract language packs
-apt-cache search tesseract-ocr
-
-# Debian/Ubuntu users
-apt-get install tesseract-ocr-chi-sim  # Example: Install Chinese Simplified language pack
-
-# Arch Linux users
-pacman -S tesseract-data-eng tesseract-data-deu # Example: Install the English and German language packs
-
-```
 
 ## Usage
 
 Basic usage. Process PDF files and write result to CSV.
+Please see the [Command-line Reference] for details.
 
 - `invoice2data invoice.pdf`
 - `invoice2data invoice.txt`
@@ -130,7 +70,7 @@ Choose any of the following input readers:
 - pdfminer.six `invoice2data --input-reader pdfminer invoice.pdf`
 - pdfplumber `invoice2data --input-reader pdfplumber invoice.pdf`
 - ocrmypdf `invoice2data --input-reader ocrmypdf invoice.pdf`
-- gvision `invoice2data --input-reader gvision invoice.pdf` (needs `GOOGLE_APPLICATION_CREDENTIALS` env var)
+- gvision `invoice2data --input-reader gvision invoice.pdf` (needs `GOOGLE_APPLICATION_CREDENTIALS` env var and a Google Cloud Bucket name. The bucket name can be set as an argument to the function ``to_text`` or as an Environment variable named ``GOOGLE_CLOUD_BUCKET_NAME`` )
 
 Choose any of the following output formats:
 
@@ -180,13 +120,12 @@ Using in-house templates
     templates = read_templates('/path/to/your/templates/')
     result = extract_data(filename, templates=templates)
 
-
 ## Template system
 
 See `invoice2data/extract/templates` for existing templates. Just extend
 the list to add your own. If deployed by a bigger organisation, there
 should be an interface to edit templates for new suppliers. 80-20 rule.
-For a short tutorial on how to add new templates, see [TUTORIAL.md](TUTORIAL.md).
+For a short tutorial on how to add new templates, see [tutorial.md](./docs/tutorial.md).
 
 Templates are based on Yaml or JSON. They define one or more keywords to find
 the right template, one or more exclude_keywords to further narrow it down
@@ -200,6 +139,7 @@ processing.
 
 Example:
 
+````yaml
     issuer: Amazon Web Services, Inc.
     keywords:
     - Amazon Web Services
@@ -223,8 +163,10 @@ Example:
         line: (.*)\$(\d+\.\d+)
         skip_line: Note
         last_line: VAT \*\*
+````
 
 The lines package has multiple settings:
+
 - start > The pattern where the lines begin. This is typically the header row of the table. This row is not included in the line matching.
 - end > The pattern denoting where the lines end. Typically some text at the very end or immediately below the table. Also not included in the line matching.
 - first_line > Optional. This is the primary line item for each entry.
@@ -237,20 +179,20 @@ As an alternative json templates can be used. Which are natively better supporte
 
 The performance with yaml templates can be greatly increased **10x** by using [libyaml](https://github.com/yaml/libyaml)
 It can be installed on most distributions by:
-`sudo apt-get libyaml-dev`
-
+`sudo apt-get install libyaml-dev`
 
 ## Development
 
 If you are interested in improving this project, have a look at our
-[developer guide](DEVELOP.md) to get you started quickly.
+[developer guide](./CONTRIBUTING.md) to get you started quickly.
 
 ## Roadmap and open tasks
 
 - integrate with online OCR?
 - try to 'guess' parameters for new invoice formats.
-- can apply machine learning to guess new parameters?
-- advanced table parsing with [camelot](https://github.com/camelot-dev/camelot)
+- apply machine learning to guess new parameters / template creation
+- Data cleanup per field
+- advanced table parsing with [pypdf_table_extraction](https://github.com/py-pdf/pypdf_table_extraction)
 
 ## Maintainers
 
@@ -258,14 +200,22 @@ If you are interested in improving this project, have a look at our
 - [Alexis de Lattre](https://github.com/alexis-via)
 - [bosd](https://github.com/bosd)
 
-## Contributors
+## Contributors and Credits
 
--   [Harshit Joshi](https://github.com/duskybomb): As Google Summer of
-    Code student.
--   [Holger Brunn](https://github.com/hbrunn): Add support for parsing
-    invoice items.
+- [Harshit Joshi](https://github.com/duskybomb): As Google Summer of
+  Code student.
+- [Holger Brunn](https://github.com/hbrunn): Add support for parsing
+  invoice items.
+
+[pypi]: https://pypi.org/
+[file an issue]: https://github.com/invoice-x/invoice2data/issues
+[pip]: https://pip.pypa.io/
+
+Contributions are very welcome.
+To learn more, see the [Contributor Guide].
 
 ## Used By
+
 - Odoo, OCA module [account_invoice_import_invoice2data](https://github.com/OCA/edi)
 
 ## Related Projects
@@ -278,3 +228,9 @@ If you are interested in improving this project, have a look at our
   (Commercial)
 - [CVision](http://www.cvisiontech.com/library/document-automation/forms-processing/extract-data-from-invoice.html)
   (Commercial)
+
+<!-- github-only -->
+
+[license]: https://invoice2data.readthedocs.io/latest/license.html
+[contributor guide]: https://invoice2data.readthedocs.io/latest/contributing.html
+[command-line reference]: https://invoice2data.readthedocs.io/latest/usage.html