Skip to content

Latest commit

 

History

History
42 lines (28 loc) · 1.39 KB

DEVELOP.md

File metadata and controls

42 lines (28 loc) · 1.39 KB
Raw

Development

If you are looking to get involved improving invoice2data, this guide will help you get started quickly.

Install

  1. Fork main repository (optional)
  2. Clone repository: git clone https://github.com/invoice-x/invoice2data
  3. Install as editable: pip install -e invoice2data

Some little-used dependencies are optional. Like pytesseract and pdfminer. Install if needed.

Folders

Major folders in the invoice2data package and their purpose:

  • input: Has modules for extracting plain text from files. Currently mostly PDF files.
  • extract: Get useful data from plain text using templates. The main class -- BaseInvoiceTemplate -- is in base_template. Other classes can add extra functions and inherit from it. E.g. LineInvoiceTemplate adds support for getting individual items.
  • extract/templates: Keeps all supported template files. Add new templates here.
  • output: Modules to output structured data. Currently CSV, JSON and XML are supported.

Testing

Every new feature should have a test to make sure it still works after modifications done by you or someone else in the future.

To install dependencies required for tests: pip install ".[test]"

To run tests using the current Python version: pytest

To run tests using all supported Python versions: tox (needs pyenv and corresponding Python versions installed.)