Skip to main content

No project description provided

Project description

Financial Statement Parser

Financial Statement Parser is a Python package for processing financial statement data. It parses structured financial data, performs calculations, and generates rolled-up financial reports.

Features

  • Parse financial statement data from text files
  • Calculate rolled-up totals for financial categories
  • Generate formatted financial reports
  • Command-line interface for easy processing

Installation

Using pip

pip install financial-statements-parser

Using poetry

poetry add financial-statements-parser

Using Docker

docker build -t fs-parser .

Usage

As a Python package

from financial_statement_parser import process_file
process_file('input_financial_data.txt', 'output_report.txt')

Command-line interface

fs-parser input_financial_data.txt -o output_report.txt

Using Docker

docker run -v /path/to/your/local/directory:/path/to/your/container/directory fs-parser:latest examples/input/example_balance_sheet.txt -o /path/to/your/container/directory/output.txt

This command mounts your local directory to a defined directory in the container. Adjust the paths as necessary.

For example:

docker run -v $HOME/Dropbox:/root/Dropbox fs-parser:latest examples/input/example_balance_sheet.txt -o /root/Dropbox/test/output.txt

To run the help message

docker run zaxier/fs-parser:latest --help

Development

To set up the development environment:

  1. Clone the repository:
git clone https://github.com/zaxier/financial-statement-parser.git
cd financial-parser
  1. Install dependencies:
poetry install
  1. Run tests:
poetry run pytest

References

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

financial_statement_parser-0.1.4.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file financial_statement_parser-0.1.4.tar.gz.

File metadata

  • Download URL: financial_statement_parser-0.1.4.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.11.9 Linux/6.5.0-1022-azure

File hashes

Hashes for financial_statement_parser-0.1.4.tar.gz
Algorithm Hash digest
SHA256 ea2f5fb7c8ff6248ac839055aee1bb45590a8d95cdbd23b7733e5ca7e8ae0f2a
MD5 098abd32f31642df89375a29e6f3c8e2
BLAKE2b-256 2c9f9233e2a9db48ea503bb0fa06812c071a50f5d8656dc53bb2dbbe2dbcd08c

See more details on using hashes here.

File details

Details for the file financial_statement_parser-0.1.4-py3-none-any.whl.

File metadata

File hashes

Hashes for financial_statement_parser-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 b3aad499d8ec034bed34ff793caedac0a169ba2f515a72ed7c4b76d0f070a74d
MD5 39698e31e9ea0d8542df4f644fab070b
BLAKE2b-256 962194590497c96754388b3e3fb9557de831d76bd2e290a01bc8a4038a919335

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page