Fix typos (#68)

build.py

@@ -60,7 +60,7 @@ def main(args: dict) -> None:
             # Run pytest in pipenv environment
             build_utils.run("pipenv run pytest", exit_on_error=True)
 
-            # Update pipfile.lock when all tests are successfull (lock environment)
+            # Update pipfile.lock when all tests are successful (lock environment)
             build_utils.run("pipenv lock", exit_on_error=True)
         else:
             # Run fast tests

docs/best_of.generators.base_generator.md

@@ -51,7 +51,7 @@ Generates the markdown output and writes into files.
  - <b>`categories`</b> (OrderedDict):  Projects categorized into configured categories. 
  - <b>`projects`</b> (list):  List of projects. 
  - <b>`config`</b> (Dict):  Best-of configuration. 
- - <b>`labels`</b> (list):  List of avaialable labels. 
+ - <b>`labels`</b> (list):  List of available labels. 
 
 
 

docs/best_of.utils.md

@@ -93,7 +93,7 @@ remove_special_chars(text: str) → str
 ## <kbd>function</kbd> `process_description`
 
 ```python
-process_description(text: str, max_lenght: int) → str
+process_description(text: str, max_length: int) → str
 ```
 
 

scripts/best-of-update-utility.ipynb

@@ -336,7 +336,7 @@
     "# CHANGE: Select a file via URL, file-path, or provide the string content here:\n",
     "EXTRACT_FROM_DATA = [\n",
     "    TEXT_DATA,\n",
-    "    # add additiona URLS or files\n",
+    "    # add additional URLS or files\n",
     "]\n",
     "\n",
     "# Run github link extraction on the provided file\n",
@@ -406,7 +406,7 @@
     "# CHANGE: Select a file via URL, file-path, or provide the string content here:\n",
     "EXTRACT_FROM_DATA = [\n",
     "    TEXT_DATA,\n",
-    "    # add additiona URLS or files\n",
+    "    # add additional URLS or files\n",
     "]\n",
     "\n",
     "# Extract projects\n",
@@ -475,7 +475,7 @@
     "# CHANGE: Select a file via URL, file-path, or provide the string content here:\n",
     "EXTRACT_FROM_DATA = [\n",
     "    TEXT_DATA,\n",
-    "    # add additiona URLS or files\n",
+    "    # add additional URLS or files\n",
     "]\n",
     "\n",
     "# Extract projects\n",
@@ -661,7 +661,7 @@
    "outputs": [],
    "source": [
     "# Select columns to show\n",
-    "selected_colum = [\n",
+    "selected_column = [\n",
     "    \"name\",\n",
     "    \"description\",\n",
     "    \"github_id\",\n",
@@ -683,7 +683,7 @@
     "    )\n",
     ")\n",
     "\n",
-    "selected_colum.extend(package_columns)\n",
+    "selected_column.extend(package_columns)\n",
     "\n",
     "if \"group_id\" not in df_updated_projects:\n",
     "    df_updated_projects[\"group_id\"] = None\n",
@@ -744,7 +744,7 @@
    "source": [
     "# Show updated projects\n",
     "qgrid_updated_projects = qgrid.show_grid(\n",
-    "    df_updated_projects[selected_colum], show_toolbar=True\n",
+    "    df_updated_projects[selected_column], show_toolbar=True\n",
     ")\n",
     "qgrid_updated_projects"
    ]
@@ -792,7 +792,7 @@
    "outputs": [],
    "source": [
     "# Select columns to show\n",
-    "selected_colums = [\n",
+    "selected_columns = [\n",
     "    \"name\",\n",
     "    \"description\",\n",
     "    \"github_id\",\n",
@@ -804,15 +804,15 @@
     "    \"group_id\",\n",
     "]\n",
     "\n",
-    "selected_colums.extend(package_columns)\n",
+    "selected_columns.extend(package_columns)\n",
     "\n",
     "# Print all available categories\n",
     "if \"category\" in df_existing_projects:\n",
     "    print(df_existing_projects[\"category\"].unique())\n",
     "\n",
     "# Show updated projects\n",
     "qgrid_finalized_projects = qgrid.show_grid(\n",
-    "    df_selected_projects[selected_colums], show_toolbar=True\n",
+    "    df_selected_projects[selected_columns], show_toolbar=True\n",
     ")\n",
     "qgrid_finalized_projects"
    ]
@@ -823,7 +823,7 @@
    "source": [
     "### Export selected projects as YAML\n",
     "\n",
-    "Export all select projects (interactivly in qgrid table above) to yaml. This output can be easily added to a best-of `projects.yaml`."
+    "Export all select projects (interactively in qgrid table above) to yaml. This output can be easily added to a best-of `projects.yaml`."
    ]
   },
   {

src/best_of/generators/markdown_list.py

@@ -85,7 +85,7 @@ def generate_metrics_info(project: Dict, configuration: Dict) -> str:
     if metrics_md:
         # add divider if metrics are available
         metrics_md = "(" + metrics_md + ")"
-        # remove unneccesary whitespaces
+        # remove unnecessary whitespaces
         utils.clean_whitespaces(metrics_md)
         # Add whitespace
         metrics_md = metrics_md + " "

src/best_of/integrations/cargo_integration.py

@@ -115,14 +115,14 @@ def generate_md_details(self, project: Dict, configuration: Dict) -> str:
 
         cargo_url = project.cargo_url or ""
         # only show : if details are available
-        seperator = (
+        separator = (
             ""
             if not configuration.generate_badges
             and not configuration.generate_install_hints
             else ":"
         )
 
-        details_md = "- [Cargo](" + cargo_url + ")" + metrics_md + seperator + "\n"
+        details_md = "- [Cargo](" + cargo_url + ")" + metrics_md + separator + "\n"
 
         if configuration.generate_install_hints:
             # TODO: Cargo install only works for binary packages

src/best_of/integrations/conda_integration.py

@@ -81,14 +81,14 @@ def generate_md_details(self, project: Dict, configuration: Dict) -> str:
             conda_package = project.conda_id.split("/")[1]
 
         # only show : if details are available
-        seperator = (
+        separator = (
             ""
             if not configuration.generate_badges
             and not configuration.generate_install_hints
             else ":"
         )
 
-        details_md = "- [Conda](" + conda_url + ")" + metrics_md + seperator + "\n"
+        details_md = "- [Conda](" + conda_url + ")" + metrics_md + separator + "\n"
 
         if configuration.generate_install_hints:
             details_md += (

src/best_of/integrations/dockerhub_integration.py

@@ -138,15 +138,15 @@ def generate_md_details(self, project: Dict, configuration: Dict) -> str:
             dockerhub_url = project.dockerhub_url
 
         # only show : if details are available
-        seperator = (
+        separator = (
             ""
             if not configuration.generate_badges
             and not configuration.generate_install_hints
             else ":"
         )
 
         details_md = (
-            "- [Docker Hub](" + dockerhub_url + ")" + metrics_md + seperator + "\n"
+            "- [Docker Hub](" + dockerhub_url + ")" + metrics_md + separator + "\n"
         )
 
         if configuration.generate_install_hints:

src/best_of/integrations/github_integration.py

@@ -561,14 +561,14 @@ def generate_github_details(project: Dict, configuration: Dict) -> str:
     # https://badgen.net/#github
 
     # only show : if details are available
-    seperator = (
+    separator = (
         ""
         if not configuration.generate_badges
         and not configuration.generate_install_hints
         else ":"
     )
 
-    details_md = "- [GitHub](" + github_url + ")" + metrics_md + seperator + "\n"
+    details_md = "- [GitHub](" + github_url + ")" + metrics_md + separator + "\n"
 
     if configuration.generate_install_hints:
         details_md += "\n\t```\n\tgit clone https://github.com/{github_id}\n\t```\n"

src/best_of/integrations/go_integration.py

@@ -49,14 +49,14 @@ def generate_md_details(self, project: Dict, configuration: Dict) -> str:
 
         go_url = project.go_url or ""
         # only show : if details are available
-        seperator = (
+        separator = (
             ""
             if not configuration.generate_badges
             and not configuration.generate_install_hints
             else ":"
         )
 
-        details_md = "- [Go](" + go_url + ")" + metrics_md + seperator + "\n"
+        details_md = "- [Go](" + go_url + ")" + metrics_md + separator + "\n"
 
         if configuration.generate_install_hints:
             details_md += "\t```\n\tgo install {go_id}\n\t```\n"

src/best_of/integrations/maven_integration.py

@@ -55,14 +55,14 @@ def generate_md_details(self, project: Dict, configuration: Dict) -> str:
             maven_url = project.maven_url
 
         # only show : if details are available
-        seperator = (
+        separator = (
             ""
             if not configuration.generate_badges
             and not configuration.generate_install_hints
             else ":"
         )
 
-        details_md = "- [Maven](" + maven_url + ")" + metrics_md + seperator + "\n"
+        details_md = "- [Maven](" + maven_url + ")" + metrics_md + separator + "\n"
 
         if configuration.generate_install_hints:
             details_md += "\t```\n\t<dependency>\n\t\t<groupId>{maven_group_id}</groupId>\n\t\t<artifactId>{maven_artifact_id}</artifactId>\n\t\t<version>[VERSION]</version>\n\t</dependency>\n\t```\n"

src/best_of/integrations/npm_integration.py

@@ -100,14 +100,14 @@ def generate_md_details(self, project: Dict, configuration: Dict) -> str:
             npm_url = project.npm_url
 
         # only show : if details are available
-        seperator = (
+        separator = (
             ""
             if not configuration.generate_badges
             and not configuration.generate_install_hints
             else ":"
         )
 
-        details_md = "- [npm](" + npm_url + ")" + metrics_md + seperator + "\n"
+        details_md = "- [npm](" + npm_url + ")" + metrics_md + separator + "\n"
 
         if configuration.generate_install_hints:
             details_md += "\t```\n\tnpm install {npm_id}\n\t```\n"

src/best_of/integrations/pypi_integration.py

@@ -70,14 +70,14 @@ def generate_md_details(self, project: Dict, configuration: Dict) -> str:
         # https://badgen.net/#pypi
 
         # only show : if details are available
-        seperator = (
+        separator = (
             ""
             if not configuration.generate_badges
             and not configuration.generate_install_hints
             else ":"
         )
 
-        details_md = "- [PyPi](" + pypi_url + ")" + metrics_md + seperator + "\n"
+        details_md = "- [PyPi](" + pypi_url + ")" + metrics_md + separator + "\n"
 
         if configuration.generate_install_hints:
             details_md += "\t```\n\tpip install {pypi_id}\n\t```\n"