From c065cbb92bfff197decc2084aaa4a51bc0211b16 Mon Sep 17 00:00:00 2001 From: Siddharth Dushantha Date: Fri, 24 May 2024 11:50:28 +0200 Subject: [PATCH 1/6] moved site_list.py to scripts/site-list.py This script is only executed by the GitHub workflow. Keeping it inside the scripts directory makes the project's directory cleaner. Additionally, it decreases the chance of contributers executing the script even though its harmless. --- .github/workflows/update-site-list.yml | 4 ++-- site_list.py => scripts/site-list.py | 0 2 files changed, 2 insertions(+), 2 deletions(-) rename site_list.py => scripts/site-list.py (100%) diff --git a/.github/workflows/update-site-list.yml b/.github/workflows/update-site-list.yml index 1966beab2..e938a6660 100644 --- a/.github/workflows/update-site-list.yml +++ b/.github/workflows/update-site-list.yml @@ -29,8 +29,8 @@ jobs: python-version: '3.x' # Execute the site_list.py Python script - - name: Execute site_list.py - run: python site_list.py + - name: Execute site-list.py + run: python scripts/site-list.py # Commit any changes made by the script - name: Commit files diff --git a/site_list.py b/scripts/site-list.py similarity index 100% rename from site_list.py rename to scripts/site-list.py From e618a5a5934a31f3a6be87445ca36383c58d3c47 Mon Sep 17 00:00:00 2001 From: Siddharth Dushantha Date: Fri, 24 May 2024 11:56:54 +0200 Subject: [PATCH 2/6] moved {removed-,}sites.md to ./docs --- removed_sites.md => docs/removed-sites.md | 0 sites.md => docs/sites.md | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename removed_sites.md => docs/removed-sites.md (100%) rename sites.md => docs/sites.md (100%) diff --git a/removed_sites.md b/docs/removed-sites.md similarity index 100% rename from removed_sites.md rename to docs/removed-sites.md diff --git a/sites.md b/docs/sites.md similarity index 100% rename from sites.md rename to docs/sites.md From ec2aa0871ec16415bc0d1ae8e708ceae1351e829 Mon Sep 17 00:00:00 2001 From: Siddharth Dushantha Date: Fri, 24 May 2024 11:58:47 +0200 Subject: [PATCH 3/6] renamed install.md to INSTALL.md --- docs/CONTRIBUTING.md | 2 +- docs/{install.md => INSTALL.md} | 0 docs/README.md | 16 ++++++++-------- 3 files changed, 9 insertions(+), 9 deletions(-) rename docs/{install.md => INSTALL.md} (100%) diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 4f1ff4c32..996efe8a3 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -11,7 +11,7 @@    |    Usage    |    - Docker + Docker    |    Contributing

diff --git a/docs/install.md b/docs/INSTALL.md similarity index 100% rename from docs/install.md rename to docs/INSTALL.md diff --git a/docs/README.md b/docs/README.md index fe3bcafc5..9496e2dda 100644 --- a/docs/README.md +++ b/docs/README.md @@ -11,7 +11,7 @@    |    Usage    |    - Docker + Docker    |    Contributing

@@ -131,13 +131,13 @@ Original Creator - [Siddharth Dushantha](https://github.com/sdushantha) -[docs_install]: /docs/install.md -[docs_docker]: /docs/install.md#docker -[docs_docker_dockerhub]: /docs/install.md#docker -[docs_docker_compose]: /docs/install.md#using-compose -[docs_docker_source]: /docs/install.md#build-image-from-source-useful-for-contributors -[docs_py]: /docs/install.md#python -[docs_py_build]: /docs/install.md#build-python-package-from-source-useful-for-contributors +[docs_install]: /docs/INSTALL.md +[docs_docker]: /docs/INSTALL.md#docker +[docs_docker_dockerhub]: /docs/INSTALL.md#docker +[docs_docker_compose]: /docs/INSTALL.md#using-compose +[docs_docker_source]: /docs/INSTALL.md#build-image-from-source-useful-for-contributors +[docs_py]: /docs/INSTALL.md#python +[docs_py_build]: /docs/INSTALL.md#build-python-package-from-source-useful-for-contributors [docs_contrib]: /docs/CONTRIBUTING.md [docs_contrib_adding_targets]: /docs/CONTRIBUTING.md#adding-targets [docs_contrib_removing_targets]: /docs/CONTRIBUTING.md#removing-targets From 7cb006526e6866296e67fb59f04ebafbb4bccfdb Mon Sep 17 00:00:00 2001 From: Siddharth Dushantha Date: Fri, 24 May 2024 11:59:12 +0200 Subject: [PATCH 4/6] removed docker-compose.yml This was an example docker-compose.yml file. This example is also available in ./docs/INSTALL.md. So keeping the file is just redundant --- docker-compose.yml | 7 ------- 1 file changed, 7 deletions(-) delete mode 100644 docker-compose.yml diff --git a/docker-compose.yml b/docker-compose.yml deleted file mode 100644 index 3182120e8..000000000 --- a/docker-compose.yml +++ /dev/null @@ -1,7 +0,0 @@ -version: '2' - -services: - sherlock: - build: . - volumes: - - "./results:/opt/sherlock/results" From a4550899be4576ae294ce0de8440c5d9d4f379c4 Mon Sep 17 00:00:00 2001 From: Siddharth Dushantha Date: Fri, 24 May 2024 12:02:36 +0200 Subject: [PATCH 5/6] Updated paths based on changes in c065cbb92bfff197decc2084aaa4a51bc0211b16 --- .dockerignore | 2 +- .github/workflows/update-site-list.yml | 2 +- {scripts => devel}/site-list.py | 6 +++--- 3 files changed, 5 insertions(+), 5 deletions(-) rename {scripts => devel}/site-list.py (85%) diff --git a/.dockerignore b/.dockerignore index 9978ae96e..21bb87de4 100644 --- a/.dockerignore +++ b/.dockerignore @@ -5,4 +5,4 @@ tests/ *.txt !/requirements.txt venv/ - +devel/ \ No newline at end of file diff --git a/.github/workflows/update-site-list.yml b/.github/workflows/update-site-list.yml index e938a6660..5a0679332 100644 --- a/.github/workflows/update-site-list.yml +++ b/.github/workflows/update-site-list.yml @@ -30,7 +30,7 @@ jobs: # Execute the site_list.py Python script - name: Execute site-list.py - run: python scripts/site-list.py + run: python devel/site-list.py # Commit any changes made by the script - name: Commit files diff --git a/scripts/site-list.py b/devel/site-list.py similarity index 85% rename from scripts/site-list.py rename to devel/site-list.py index 1f0f05fd4..1b4a03cfb 100644 --- a/scripts/site-list.py +++ b/devel/site-list.py @@ -4,7 +4,7 @@ import json # Read the data.json file -with open("sherlock/resources/data.json", "r", encoding="utf-8") as data_file: +with open("../sherlock/resources/data.json", "r", encoding="utf-8") as data_file: data: dict = json.load(data_file) # Removes schema-specific keywords for proper processing @@ -15,7 +15,7 @@ social_networks: list = sorted(social_networks.items()) # Write the list of supported sites to sites.md -with open("sites.md", "w") as site_file: +with open("../sites.md", "w") as site_file: site_file.write(f"## List Of Supported Sites ({len(social_networks)} Sites In Total!)\n") for social_network, info in social_networks: url_main = info["urlMain"] @@ -23,7 +23,7 @@ site_file.write(f"1. ![](https://www.google.com/s2/favicons?domain={url_main}) [{social_network}]({url_main}) {is_nsfw}\n") # Overwrite the data.json file with sorted data -with open("sherlock/resources/data.json", "w") as data_file: +with open("../sherlock/resources/data.json", "w") as data_file: sorted_data = json.dumps(data, indent=2, sort_keys=True) data_file.write(sorted_data) data_file.write("\n") From 2486e49a29e893af8c81fdbfb70181741146e113 Mon Sep 17 00:00:00 2001 From: Paul Pfeister Date: Fri, 24 May 2024 15:51:25 -0400 Subject: [PATCH 6/6] Fix URI in header --- docs/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/README.md b/docs/README.md index 9496e2dda..9df30261d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -2,7 +2,7 @@

- Hunt down social media accounts by username across 400+ social networks + Hunt down social media accounts by username across 400+ social networks