Change tag name to top-level-section-start-marker

Elijas · Oct 11, 2023 · 8a56e27 · 8a56e27
1 parent a80e3a8
commit 8a56e27
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -79,25 +79,25 @@ for line in html.splitlines():
     print(line[:65] + '...')
 ```
 
-    <root-section-separator id="part1item1" title="Financial Statemen...
+    <top-level-section-start-marker id="part1item1" title="Financial Statemen...
     <span style="color:#000000;font-family:'Helvetica',sans-serif;fon...
-    <root-section-separator id="part1item2" title="Management's Discu...
+    <top-level-section-start-marker id="part1item2" title="Management's Discu...
     <span style="color:#000000;font-family:'Helvetica',sans-serif;fon...
-    <root-section-separator id="part1item3" title="Quantitative and Q...
+    <top-level-section-start-marker id="part1item3" title="Quantitative and Q...
     <span style="color:#000000;font-family:'Helvetica',sans-serif;fon...
-    <root-section-separator id="part1item4" title="Controls and Proce...
+    <top-level-section-start-marker id="part1item4" title="Controls and Proce...
     <span style="color:#000000;font-family:'Helvetica',sans-serif;fon...
-    <root-section-separator id="part2item1" title="Legal Proceedings"...
+    <top-level-section-start-marker id="part2item1" title="Legal Proceedings"...
     <span style="color:#000000;font-family:'Helvetica',sans-serif;fon...
-    <root-section-separator id="part2item1a" title="Risk Factors" com...
+    <top-level-section-start-marker id="part2item1a" title="Risk Factors" com...
     <span style="color:#000000;font-family:'Helvetica',sans-serif;fon...
-    <root-section-separator id="part2item2" title="Unregistered Sales...
+    <top-level-section-start-marker id="part2item2" title="Unregistered Sales...
     <span style="color:#000000;font-family:'Helvetica',sans-serif;fon...
-    <root-section-separator id="part2item3" title="Defaults Upon Seni...
+    <top-level-section-start-marker id="part2item3" title="Defaults Upon Seni...
     <span style="color:#000000;font-family:'Helvetica',sans-serif;fon...
-    <root-section-separator id="part2item4" title="Mine Safety Disclo...
+    <top-level-section-start-marker id="part2item4" title="Mine Safety Disclo...
     <span style="color:#000000;font-family:'Helvetica',sans-serif;fon...
-    <root-section-separator id="part2item5" title="Other Information"...
+    <top-level-section-start-marker id="part2item5" title="Other Information"...
     <span style="color:#000000;font-family:'Helvetica',sans-serif;fon...
-    <root-section-separator id="part2item6" title="Exhibits" comment=...
+    <top-level-section-start-marker id="part2item6" title="Exhibits" comment=...
     <span style="color:#000000;font-family:'Helvetica',sans-serif;fon...
diff --git a/nbs/index.ipynb b/nbs/index.ipynb
@@ -104,6 +104,17 @@
     "!pip install -q python-dotenv"
    ]
   },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from dotenv import load_dotenv\n",
+    "\n",
+    "load_dotenv() # Load the API key from .env file into the environment variable SECAPIO_API_KEY"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,

diff --git a/sec_api_io/__init__.py b/sec_api_io/__init__.py
@@ -1 +1 @@
-__version__ = "0.0.6"
+__version__ = "0.0.7"
diff --git a/sec_api_io/secapio_data_retriever.py b/sec_api_io/secapio_data_retriever.py
@@ -5,6 +5,7 @@
 from typing import TYPE_CHECKING
 
 import httpx
+
 from sec_api_io.abstract_sec_data_retriever import (
     AbstractSECDataRetriever,
     DocumentTypeNotSupportedError,
@@ -132,13 +133,13 @@ def _get_report_html(
             title = SECTION_NAMES[section]
             title = re.sub(r"[^a-zA-Z0-9' ]+", "", title)
             separator_html = (
-                "<root-section-separator"
+                "<top-level-section-start-marker"
                 f' id="{section.value}"'
                 f' title="{title}"'
                 ' comment="This tag was added by '
                 'SecApiIoDataRetriever class based on sec-api.io API"'
                 ' style="display: none;"'
-                "</root-section-separator>"
+                "</top-level-section-start-marker>"
             )
             html_parts.append(separator_html)
             section_html = self._call_sections_extractor_api(

diff --git a/settings.ini b/settings.ini
@@ -1,7 +1,7 @@
 [DEFAULT]
 repo = sec-api-io
 lib_name = sec-api-io
-version = 0.0.6
+version = 0.0.7
 min_python = 3.7
 license = apache2
 black_formatting = False