Merge pull request #2134 from sherlock-project/dir-cleanup

Project directory cleanup

.dockerignore

@@ -5,4 +5,4 @@ tests/
 *.txt
 !/requirements.txt
 venv/
-
+devel/

.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 devel/site-list.py
 
        # Commit any changes made by the script
       - name: Commit files

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.pop('$schema', None)
 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 @@ with open("sites.md", "w") as site_file:
         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")

docker-compose.yml

@@ -1,7 +0,0 @@
-version: '2'
-
-services:
-  sherlock:
-    build: .
-    volumes:
-      - "./results:/opt/sherlock/results"

docs/CONTRIBUTING.md

@@ -11,7 +11,7 @@
      |   
   <a href="https://github.com/sherlock-project/sherlock#usage">Usage</a>
   &nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
-  <a href="https://github.com/sherlock-project/sherlock/docs/install.md#docker">Docker</a>
+  <a href="https://github.com/sherlock-project/sherlock/docs/INSTALL.md#docker">Docker</a>
   &nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
   <strong><a href="https://github.com/sherlock-project/sherlock/docs/CONTRIBUTING.md">Contributing</a></strong>
 </p>

docs/README.md

@@ -2,7 +2,7 @@
   <br>
   <a href="https://sherlock-project.github.io/" target="_blank"><img src="https://user-images.githubusercontent.com/27065646/53551960-ae4dff80-3b3a-11e9-9075-cef786c69364.png"/></a>
   <br>
-  <span>Hunt down social media accounts by username across <a href="https://github.com/sherlock-project/sherlock/blob/master/sites.md">400+ social networks</a></span>
+  <span>Hunt down social media accounts by username across <a href="https://github.com/sherlock-project/sherlock/blob/master/docs/sites.md">400+ social networks</a></span>
   <br>
 </p>
 
@@ -11,7 +11,7 @@
   &nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
   <a href="https://github.com/sherlock-project/sherlock#usage">Usage</a>
   &nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
-  <a href="https://github.com/ppfeister/sherlock/blob/feature/docu/docs/install.md#docker">Docker</a>
+  <a href="https://github.com/ppfeister/sherlock/blob/feature/docu/docs/INSTALL.md#docker">Docker</a>
   &nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
   <a href="https://github.com/ppfeister/sherlock/blob/feature/docu/docs/CONTRIBUTING.md">Contributing</a>
 </p>
@@ -131,13 +131,13 @@ Original Creator - [Siddharth Dushantha](https://github.com/sdushantha)
 
 <!-- Reference Links -->
 
-[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