From 25ada13145d04cdc8050df8a00c6df6d0d63dab9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Elijas=20Dap=C5=A1auskas?= <4084885+Elijas@users.noreply.github.com> Date: Mon, 25 Sep 2023 22:29:25 +0300 Subject: [PATCH] docs(readme): add link to demo, other small changes --- README.md | 23 ++++++++++++++--------- 1 file changed, 14 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index a00e1ab..733ca23 100644 --- a/README.md +++ b/README.md @@ -11,6 +11,8 @@ The `sec-parser` project simplifies the process of extracting meaningful informa This tool is especially beneficial for Artificial Intelligence (AI) and Large Language Models (LLM) applications. It significantly improves the efficiency of data extraction and analysis in these fields. +[**View Demo**](https://sec-parser-output-visualizer.app.alphanome.dev/) + ## Installation You can install `sec-parser` using pip: @@ -22,18 +24,21 @@ pip install sec-parser ## Usage ```python -from sec_parser import parse_latest +import sec_parser as sp -tree = parse_latest("10-K", ticker="AAPL") +tree = sp.parse_latest("10-K", ticker="AAPL") +# Show the general structure of the tree print(tree.render()) -# RootSectionElement: PART I — FINANCIAL INFORMATION -# ├── TitleElement: Item 1. Financial Statements -# ├── TitleElement: Apple Inc. -# ├── TitleElement: CONDENSED CONSOLIDATED STATEMENTS OF OPERATIONS (U... -# │ ├── TextElement: (In millions, except number of shares which are re... -# │ ├── TableElement: ... -# │ ... +``` +Console output: +``` +RootSectionElement: PART I — FINANCIAL INFORMATION +├── TitleElement: Item 1. Financial Statements +│ ├── TitleElement: CONDENSED CONSOLIDATED STATEMENTS OF OPERATIONS (U... +│ │ ├── TextElement: (In millions, except number of shares which are re... +│ │ ├── TableElement: ... +│ ... ``` # License