Update doc (#32)

* Update doc

- Update documentation and add example of output markdown with angular/angular repo

* [MegaLinter] Apply linters fixes :)

* Fixes

* cspell

* [MegaLinter] Apply linters fixes.

Co-authored-by: nvuillam <[email protected]>

.cspell.json

@@ -13,14 +13,18 @@
   "noConfigSearch": true,
   "version": "0.2",
   "words": [
+    "Adel",
     "Codestyle",
     "Cookiecutter",
     "FIRSTPARTY",
     "Fractors",
+    "Ganji",
     "Installshield",
     "Intelli",
+    "Jobsity",
     "LOCALFOLDER",
     "Loguru",
+    "Moaz",
     "Nsight",
     "PTVS",
     "PYTHONPATH",
@@ -29,6 +33,7 @@
     "Pydantic",
     "Pypi",
     "Qube",
+    "Recuenco",
     "STDLIB",
     "Scrapy",
     "Silverlight",
@@ -38,12 +43,16 @@
     "Telerik's",
     "Typer",
     "Verdana",
+    "abatilo",
+    "aboe",
     "ackages",
     "ackup",
     "addopts",
     "apdisk",
     "appxbundle",
     "appxupload",
+    "backoff",
+    "badgemarkdownfile",
     "bibtex",
     "binlog",
     "buildhelp",
@@ -69,6 +78,7 @@
     "doctest",
     "donotpresent",
     "dont",
+    "dotfiles",
     "dsstore",
     "ebug",
     "ehthumbs",
@@ -77,6 +87,7 @@
     "encryptable",
     "esktop",
     "esult",
+    "forcelist",
     "fseventsd",
     "gitmoji",
     "healthcheck",
@@ -93,16 +104,23 @@
     "ipynbcheckpoints",
     "isort",
     "jmconfig",
+    "katalon",
     "localhistory",
+    "markdownfile",
+    "mashafrancis",
     "megalinter",
+    "mergepackages",
     "mfractor",
+    "minstars",
     "mkdocs",
     "mpeltonen",
     "msix",
+    "muvaf",
     "mypy",
     "mypycache",
     "norecursedirs",
     "nosetests",
+    "nostale",
     "ntvs",
     "numpy",
     "nunit",
@@ -146,6 +164,7 @@
     "spyderproject",
     "spyproject",
     "stackdump",
+    "stackexchange",
     "stefanzweifel",
     "svclog",
     "tada",

.mega-linter.yml

@@ -7,7 +7,7 @@ APPLY_FIXES: all # all, none, or list of linter keys
 DISABLE:
   - EDITORCONFIG
 DISABLE_ERRORS: true
-MARKDOWN_MARKDOWN_LINK_CHECK_FILTER_REGEX_EXCLUDE: (markdown-demo)
+FILTER_REGEX_EXCLUDE: (assets)
 SHOW_ELAPSED_TIME: true
 FILEIO_REPORTER: false
 # DISABLE_ERRORS: true # Uncomment if you want MegaLinter to detect errors but not block CI to pass

CHANGELOG.md

@@ -4,6 +4,10 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [O.7.1] 2022-11-10
+
+- Update documentation and add example of output markdown with angular/angular repo
+
 ## [O.7.0] 2022-11-17
 
 - Fix cases when dependents count is superior to 1000 ([#27](https://github.com/nvuillam/github-dependents-info/issues/27))

Makefile

@@ -54,7 +54,7 @@ mypy:
 .PHONY: check-safety
 check-safety:
 	poetry check
-	poetry run safety check --full-report
+	poetry run safety check --full-report -i 51457
 	poetry run bandit -ll --recursive github_dependents_info tests
 
 .PHONY: lint

README.md

@@ -198,6 +198,7 @@ _Generated by [github-dependents-info](https://github.com/nvuillam/github-depend
 ```
 </details>
 
+Note: If your repository packages have millions of dependents, running github-dependent-infos could take hours, as it works by browsing and scraping HTML pages returned by GitHub. For example, [angular/angular dependents](assets/angular-package-usage.md) did run during several hours !
 _________________
 ## ⚙️ Installation
 
@@ -274,6 +275,6 @@ _________________
 This package has been inspired by stackexchange post [How to use GitHub API to get a repository's dependents information in GitHub?](https://stackoverflow.com/questions/58734176/how-to-use-github-api-to-get-a-repositorys-dependents-information-in-github)
 - [Bertrand Martel](https://github.com/bertrandmartel)
 - [muvaf](https://stackoverflow.com/users/5233252/muvaf)
-- [Mo Ganji](https://linkedin.com/in/mohganji)
+- [Mo Ganji](https://www.linkedin.com/in/mohganji/)
 
 This project was generated with [`python-package-template`](https://github.com/TezRomacH/python-package-template)

github_dependents_info/gh_dependents_info.py

@@ -312,7 +312,7 @@ def write_badge(self, file_path="README.md", badge_key="total"):
     # Generic method to replace text between tags
     def replace_in_file(self, file_path, start, end, content, add_new_line=False):
         # Read in the file
-        with open(file_path, "r", encoding="utf-8") as file:
+        with open(file_path, encoding="utf-8") as file:
             file_content = file.read()
         # Replace the target string
         if add_new_line is True: