From d25df2f5c85c86cd0c41077ebefa196cb098866f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Elijas=20Dap=C5=A1auskas?= <4084885+Elijas@users.noreply.github.com> Date: Wed, 5 Jun 2024 00:06:41 +0300 Subject: [PATCH] Update README.md --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index dcd3c17..609ea28 100644 --- a/README.md +++ b/README.md @@ -123,7 +123,7 @@ First, install the `sec-parser` package using pip: pip install sec-parser ``` -In order to run the example code in this README, you'll also need the `sec_downloader` package: +To run the example code in this README, you'll also need the `sec_downloader` package: ```bash pip install sec-downloader @@ -146,6 +146,9 @@ html = dl.get_filing_html(ticker="AAPL", form="10-Q") > [!NOTE] > The company name and email address are used to form a user-agent string that adheres to the SEC EDGAR's fair access policy for programmatic downloading. [Source](https://www.sec.gov/os/webmaster-faq#code-support) +> [!TIP] +> Read [sec-downloader documentation](https://github.com/Elijas/sec-downloader) (and [examples](https://discord.com/channels/1164249739836018698/1247302201836175401/1247655286102298757)) for more advanced usage (such as downloading three latest Apple 10-Q filings instead of just one, or downloading based on a specific CIK or Filing ID (i.e. accession number)). + Now, we can parse the filing HTML into a list of semantic elements: ```python