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.3.tar.gz (4.4 kB view hashes)

Uploaded Source

Built Distribution

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