From e2352756bf86753d912409c69e5f0b6c85d6270b Mon Sep 17 00:00:00 2001 From: Elijas <4084885+Elijas@users.noreply.github.com> Date: Fri, 17 Nov 2023 05:35:04 +0200 Subject: [PATCH] docs: update readme --- README.md | 73 +++++++++++++++++++++++++++---------------------- nbs/index.ipynb | 73 +++++++++++++++++++++++++++---------------------- 2 files changed, 82 insertions(+), 64 deletions(-) diff --git a/README.md b/README.md index b5b21a5..933b1c1 100644 --- a/README.md +++ b/README.md @@ -65,16 +65,16 @@ metadatas = dl.get_filing_metadatas("AAPL/0000320193-23-000077") print(metadatas) ``` - FilingMetadata(accession_number='0000320193-23-000077', - form_type='10-Q', - primary_doc_url='https://www.sec.gov/Archives/edgar/data/320193/000032019323000077/aapl-20230701.htm', - items='', - primary_doc_description='10-Q', - filing_date='2023-08-04', - report_date='2023-07-01', - cik='0000320193', - company_name='Apple Inc.', - tickers=[Ticker(symbol='AAPL', exchange='Nasdaq')]) + [FilingMetadata(accession_number='0000320193-23-000077', + form_type='10-Q', + primary_doc_url='https://www.sec.gov/Archives/edgar/data/320193/000032019323000077/aapl-20230701.htm', + items='', + primary_doc_description='10-Q', + filing_date='2023-08-04', + report_date='2023-07-01', + cik='0000320193', + company_name='Apple Inc.', + tickers=[Ticker(symbol='AAPL', exchange='Nasdaq')])] Alternatively, you can also use any of these to get the same answer: @@ -94,17 +94,17 @@ metadatas = dl.get_filing_metadatas( print(metadatas) ``` - FilingMetadata(accession_number='0001193125-23-272204', - form_type='8-K', - primary_doc_url='https://www.sec.gov/Archives/edgar/data/1067983/000119312523272204/d564412d8k.htm', - items='2.02,9.01', - primary_doc_description='8-K', - filing_date='2023-11-07', - report_date='2023-11-04', - cik='0001067983', - company_name='BERKSHIRE HATHAWAY INC', - tickers=[Ticker(symbol='BRK-B', exchange='NYSE'), - Ticker(symbol='BRK-A', exchange='NYSE')]) + [FilingMetadata(accession_number='0001193125-23-272204', + form_type='8-K', + primary_doc_url='https://www.sec.gov/Archives/edgar/data/1067983/000119312523272204/d564412d8k.htm', + items='2.02,9.01', + primary_doc_description='8-K', + filing_date='2023-11-07', + report_date='2023-11-04', + cik='0001067983', + company_name='BERKSHIRE HATHAWAY INC', + tickers=[Ticker(symbol='BRK-B', exchange='NYSE'), + Ticker(symbol='BRK-A', exchange='NYSE')])] Alternatively, you can also URLs in other formats and get the same answer: @@ -122,17 +122,26 @@ metadatas = dl.get_filing_metadatas( print(metadatas) ``` - [FilingMetadata(accession_number='0001193125-23-272204', - form_type='8-K', - primary_doc_url='https://www.sec.gov/Archives/edgar/data/1067983/000119312523272204/d564412d8k.htm', - items='2.02,9.01', - primary_doc_description='8-K', - filing_date='2023-11-07', - report_date='2023-11-04', - cik='0001067983', - company_name='BERKSHIRE HATHAWAY INC', - tickers=[Ticker(symbol='BRK-B', exchange='NYSE'), - Ticker(symbol='BRK-A', exchange='NYSE')])] + [FilingMetadata(accession_number='0000950170-23-035122', + form_type='10-K', + primary_doc_url='https://www.sec.gov/Archives/edgar/data/789019/000095017023035122/msft-20230630.htm', + items='', + primary_doc_description='10-K', + filing_date='2023-07-27', + report_date='2023-06-30', + cik='0000789019', + company_name='MICROSOFT CORP', + tickers=[Ticker(symbol='MSFT', exchange='Nasdaq')]), + FilingMetadata(accession_number='0001564590-22-026876', + form_type='10-K', + primary_doc_url='https://www.sec.gov/Archives/edgar/data/789019/000156459022026876/msft-10k_20220630.htm', + items='', + primary_doc_description='10-K', + filing_date='2022-07-28', + report_date='2022-06-30', + cik='0000789019', + company_name='MICROSOFT CORP', + tickers=[Ticker(symbol='MSFT', exchange='Nasdaq')])] Alternatively, you can also use any of these to get the same answer: diff --git a/nbs/index.ipynb b/nbs/index.ipynb index dad5d4d..7c68a72 100644 --- a/nbs/index.ipynb +++ b/nbs/index.ipynb @@ -156,16 +156,16 @@ "name": "stdout", "output_type": "stream", "text": [ - "FilingMetadata(accession_number='0000320193-23-000077',\n", - " form_type='10-Q',\n", - " primary_doc_url='https://www.sec.gov/Archives/edgar/data/320193/000032019323000077/aapl-20230701.htm',\n", - " items='',\n", - " primary_doc_description='10-Q',\n", - " filing_date='2023-08-04',\n", - " report_date='2023-07-01',\n", - " cik='0000320193',\n", - " company_name='Apple Inc.',\n", - " tickers=[Ticker(symbol='AAPL', exchange='Nasdaq')])\n" + "[FilingMetadata(accession_number='0000320193-23-000077',\n", + " form_type='10-Q',\n", + " primary_doc_url='https://www.sec.gov/Archives/edgar/data/320193/000032019323000077/aapl-20230701.htm',\n", + " items='',\n", + " primary_doc_description='10-Q',\n", + " filing_date='2023-08-04',\n", + " report_date='2023-07-01',\n", + " cik='0000320193',\n", + " company_name='Apple Inc.',\n", + " tickers=[Ticker(symbol='AAPL', exchange='Nasdaq')])]\n" ] } ], @@ -204,17 +204,17 @@ "name": "stdout", "output_type": "stream", "text": [ - "FilingMetadata(accession_number='0001193125-23-272204',\n", - " form_type='8-K',\n", - " primary_doc_url='https://www.sec.gov/Archives/edgar/data/1067983/000119312523272204/d564412d8k.htm',\n", - " items='2.02,9.01',\n", - " primary_doc_description='8-K',\n", - " filing_date='2023-11-07',\n", - " report_date='2023-11-04',\n", - " cik='0001067983',\n", - " company_name='BERKSHIRE HATHAWAY INC',\n", - " tickers=[Ticker(symbol='BRK-B', exchange='NYSE'),\n", - " Ticker(symbol='BRK-A', exchange='NYSE')])\n" + "[FilingMetadata(accession_number='0001193125-23-272204',\n", + " form_type='8-K',\n", + " primary_doc_url='https://www.sec.gov/Archives/edgar/data/1067983/000119312523272204/d564412d8k.htm',\n", + " items='2.02,9.01',\n", + " primary_doc_description='8-K',\n", + " filing_date='2023-11-07',\n", + " report_date='2023-11-04',\n", + " cik='0001067983',\n", + " company_name='BERKSHIRE HATHAWAY INC',\n", + " tickers=[Ticker(symbol='BRK-B', exchange='NYSE'),\n", + " Ticker(symbol='BRK-A', exchange='NYSE')])]\n" ] } ], @@ -251,17 +251,26 @@ "name": "stdout", "output_type": "stream", "text": [ - "[FilingMetadata(accession_number='0001193125-23-272204',\n", - " form_type='8-K',\n", - " primary_doc_url='https://www.sec.gov/Archives/edgar/data/1067983/000119312523272204/d564412d8k.htm',\n", - " items='2.02,9.01',\n", - " primary_doc_description='8-K',\n", - " filing_date='2023-11-07',\n", - " report_date='2023-11-04',\n", - " cik='0001067983',\n", - " company_name='BERKSHIRE HATHAWAY INC',\n", - " tickers=[Ticker(symbol='BRK-B', exchange='NYSE'),\n", - " Ticker(symbol='BRK-A', exchange='NYSE')])]\n" + "[FilingMetadata(accession_number='0000950170-23-035122',\n", + " form_type='10-K',\n", + " primary_doc_url='https://www.sec.gov/Archives/edgar/data/789019/000095017023035122/msft-20230630.htm',\n", + " items='',\n", + " primary_doc_description='10-K',\n", + " filing_date='2023-07-27',\n", + " report_date='2023-06-30',\n", + " cik='0000789019',\n", + " company_name='MICROSOFT CORP',\n", + " tickers=[Ticker(symbol='MSFT', exchange='Nasdaq')]),\n", + " FilingMetadata(accession_number='0001564590-22-026876',\n", + " form_type='10-K',\n", + " primary_doc_url='https://www.sec.gov/Archives/edgar/data/789019/000156459022026876/msft-10k_20220630.htm',\n", + " items='',\n", + " primary_doc_description='10-K',\n", + " filing_date='2022-07-28',\n", + " report_date='2022-06-30',\n", + " cik='0000789019',\n", + " company_name='MICROSOFT CORP',\n", + " tickers=[Ticker(symbol='MSFT', exchange='Nasdaq')])]\n" ] } ],