license&readme

wilzhub · Nov 17, 2022 · 35ec71b · 35ec71b
1 parent 69b519a
commit 35ec71b
Show file tree

Hide file tree

Showing 14 changed files with 151 additions and 138 deletions.
diff --git a/GitHubSearch.php b/GitHubSearch.php
@@ -1,11 +1,5 @@
 <?php
 
-/**
- * I don't believe in license
- * You can do want you want with this program
- * - gwen -
- */
-
 class GitHubSearch
 {
 	const FS = '+';

diff --git a/LICENSE.md b/LICENSE.md
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Gwendal Le Coguic
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,13 +1,40 @@
+<h1 align="center">github-search</h1>
 
-Most of these scripts require a GitHub token. If you're lazy like me, you can create a `.tokens` file in the cloned repo directory with 1 token per line.
+<h4 align="center">A collection of tools to perform searches on GitHub.</h4>
+
+<p align="center">
+    <img src="https://img.shields.io/badge/python-v3-blue" alt="python badge">
+    <img src="https://img.shields.io/badge/license-MIT-green" alt="MIT license badge">
+    <a href="https://twitter.com/intent/tweet?text=https%3a%2f%2fgithub.com%2fgwen001%2fgithub-search%2f" target="_blank"><img src="https://img.shields.io/twitter/url?style=social&url=https%3A%2F%2Fgithub.com%2Fgwen001%2Fgithub-search" alt="twitter badge"></a>
+</p>
+
+<p align="center">
+    <img src="https://img.shields.io/github/stars/gwen001/github-search?style=social" alt="github stars badge">
+    <img src="https://img.shields.io/github/watchers/gwen001/github-search?style=social" alt="github watchers badge">
+    <img src="https://img.shields.io/github/forks/gwen001/github-search?style=social" alt="github forks badge">
+</p>
+
+---
+
+## Install
+
+```
+git clone https://github.com/gwen001/github-search
+cd github-search
+pip3 install -r requirements.txt
+```
+
+Most of the time GitHub requies a token to perform searches.  
+You can create a `.tokens` file in the cloned repo directory with 1 token per line  
+OR  
+You can configure an environment variable like this: `GIHTHUB_TOKEN=token1,token2,...`
+
+## Usage
 
 Documentation here: http://10degres.net/github-tools-collection/  
 
-I don't believe in license.  
-You can do whatever you want with this program.  
 
-Anyway there is a way to support :)  
+---
 
-<a href="https://github.com/sponsors/gwen001" title="Sponsor gwen001"><img src="https://raw.githubusercontent.com/gwen001/pentest-tools/master/github-sponsor.jpg" alt="Sponsor gwen001" title="Sponsor gwen001"></a>
+Feel free to [open an issue](/../../issues/) if you have any problem with the script.  
 
-Found a bug? Feel free to open an issue https://github.com/gwen001/github-search/issues
diff --git a/Utils.php b/Utils.php
@@ -1,11 +1,5 @@
 <?php
 
-/**
- * I don't believe in license
- * You can do want you want with this program
- * - gwen -
- */
-
 class Utils
 {
 	const TMP_DIR = '/tmp/';

diff --git a/git-history.py b/git-history.py
@@ -1,8 +1,5 @@
 #!/usr/bin/python2
 
-# I don't believe in license.
-# You can do whatever you want with this program.
-
 import os
 import sys
 import json

diff --git a/git-pillage.py b/git-pillage.py
@@ -4,10 +4,6 @@
 # inspired by https://github.com/koto/gitpillage/blob/master/gitpillage.sh
 # example: python3 gitpillage.py -u https://www.example.com -t 10
 
-# I don't believe in license.
-# You can do whatever you want with this program.
-
-
 #
 ### functions
 #

diff --git a/github-contributors.py b/github-contributors.py
@@ -1,8 +1,5 @@
 #!/usr/bin/python2
 
-# I don't believe in license.
-# You can do whatever you want with this program.
-
 import os
 import sys
 import json

diff --git a/github-dorks.py b/github-dorks.py
@@ -1,8 +1,5 @@
 #!/usr/bin/python2
 
-# I don't believe in license.
-# You can do whatever you want with this program.
-
 import os
 import sys
 import json

diff --git a/github-employees.py b/github-employees.py
@@ -1,8 +1,5 @@
 #!/usr/bin/python3
 
-# I don't believe in license.
-# You can do whatever you want with this program.
-
 import os
 import sys
 import time

diff --git a/github-endpoints.py b/github-endpoints.py
@@ -1,8 +1,5 @@
 #!/usr/bin/python3
 
-# I don't believe in license.
-# You can do whatever you want with this program.
-
 import os
 import sys
 import re

diff --git a/github-search.php b/github-search.php
@@ -1,12 +1,6 @@
 #!/usr/bin/php
 <?php
 
-/**
- * I don't believe in license
- * You can do want you want with this program
- * - gwen -
- */
-
 function __autoload( $c ) {
 	include( $c.'.php' );
 }
@@ -56,31 +50,31 @@ function __autoload( $c ) {
 			case 'f':
 				$gsearch->setFilename( $v );
 				break;
-			
+
 			case 'h':
 				Utils::help();
 				break;
-			
+
 			case 'l':
 				$gsearch->setLanguage( $v );
 				break;
-			
+
 			case 'm':
 				$gsearch->searchCommit( true );
 				break;
-			
+
 			case 'n':
 				$gsearch->setColorOutput( false );
 				break;
-			
+
 			case 'o':
 				$gsearch->setOrganization( $v );
 				break;
-			
+
 			case 'p':
 				$gsearch->setRepository( $v );
 				break;
-			
+
 			case 'r':
 				$gsearch->setMaxResult( $v );
 				break;
@@ -97,7 +91,7 @@ function __autoload( $c ) {
 				Utils::help( 'Unknown option: '.$k );
 		}
 	}
-	
+
 	if( !$gsearch->getString() && !$gsearch->getFilename() ) {
 		Utils::help( 'Search param not found, provide at least a filename or a string' );
 	}
@@ -115,7 +109,7 @@ function __autoload( $c ) {
 	} else {
 		$cnt_result = $gsearch->run();
 	}
-	
+
 	if( $cnt_result ) {
 		$gsearch->printResult();
 	}

diff --git a/github-secrets.py b/github-secrets.py
@@ -1,8 +1,5 @@
 #!/usr/bin/python3
 
-# I don't believe in license.
-# You can do whatever you want with this program.
-
 import os
 import sys
 import re

diff --git a/github-subdomains.py b/github-subdomains.py
@@ -1,8 +1,5 @@
 #!/usr/bin/python3
 
-# I don't believe in license.
-# You can do whatever you want with this program.
-
 import os
 import sys
 import re