https://github.com/cityssm/bill-data-extract

Extract data from scanned bill documents into usable details.
https://github.com/cityssm/bill-data-extract

sault-ste-marie sectorflow tesseract

Last synced: 27 days ago
JSON representation

Extract data from scanned bill documents into usable details.

• Host: GitHub
• URL: https://github.com/cityssm/bill-data-extract
• Owner: cityssm
• License: mit
• Created: 2024-04-23T19:45:20.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-08-12T13:44:11.000Z (5 months ago)
• Last Synced: 2024-12-02T22:28:18.197Z (about 1 month ago)
• Topics: sault-ste-marie, sectorflow, tesseract
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@cityssm/bill-data-extract
• Size: 377 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Bill Data Extract

[![npm (scoped)](https://img.shields.io/npm/v/%40cityssm/bill-data-extract)](https://www.npmjs.com/package/@cityssm/bill-data-extract)

[![DeepSource](https://app.deepsource.com/gh/cityssm/bill-data-extract.svg/?label=active+issues&show_trend=true&token=yOE-jaj4mEuAieY_Jemi9vEq)](https://app.deepsource.com/gh/cityssm/bill-data-extract/)

Extract data from scanned bill documents into usable details.

## Supported Bills

- [Enbridge Gas](https://www.enbridgegas.com/)

- [PUC Services Inc. (Sault Ste. Marie)](https://ssmpuc.com/)

- 🚧 Other utility bills using [SectorFlow](https://sectorflow.ai/)'s AI platform.

## Installation

```sh

npm install @cityssm/bill-data-extract

```

## Usage

```javascript

import { extractEnbridgeBillData } from '@cityssm/bill-data-extract/enbridge.js'

const billData = await extractEnbridgeBillData('path/to/enbridgeBill.pdf')

console.log(billData)

/*

  {

    accountNumber: '123456789012',

    serviceAddress: '123 FAKE ST BIG CITY ON G4S 0I0',

    dueDate: 'May 04, 2024',

    gasUsage: 139,

    gasUsageUnit: 'm3',

    totalAmountDue: 60.35

  } 

*/

```

## How Does It Work?

![Enbridge Bill Sample](docs/enbridgeSample.png)

The extractor takes a bill as input, either as an image or as a PDF.

"Zones" are identified within the bill to identify where the key details are.

Using [tesseract.js](http://tesseract.projectnaptha.com/) on those zones,

data is extracted and returned as a Javascript object.

💡 Note that while scanned copies of bills are oftentimes supported,

the best source is a bill downloaded directly from the utility company.