Skip to content

Commit c7e4c68

Browse files
committed
Add setup.py
This commit adds a setup.py file to allow users to install github-dorks more easily.
1 parent a80bd9e commit c7e4c68

File tree

2 files changed

+27
-7
lines changed

2 files changed

+27
-7
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This tool uses [github3.py](https://github.com/sigmavirus24/github3.py) to talk
1313
Clone this repository and run:
1414

1515
```shell
16-
pip install -r requirements.txt
16+
pip install .
1717
```
1818

1919
### Usage
@@ -28,17 +28,17 @@ GH_URL - Environment variable to specify GitHub Enterprise base URL
2828
Some example usages are listed below:
2929

3030
```shell
31-
python github-dork.py -r techgaun/github-dorks # search a single repo
31+
github-dork.py -r techgaun/github-dorks # search a single repo
3232

33-
python github-dork.py -u techgaun # search all repos of a user
33+
github-dork.py -u techgaun # search all repos of a user
3434

35-
python github-dork.py -u dev-nepal # search all repos of an organization
35+
github-dork.py -u dev-nepal # search all repos of an organization
3636

37-
GH_USER=techgaun GH_PWD=<mypass> python github-dork.py -u dev-nepal # search as authenticated user
37+
GH_USER=techgaun GH_PWD=<mypass> github-dork.py -u dev-nepal # search as authenticated user
3838

39-
GH_TOKEN=<github_token> python github-dork.py -u dev-nepal # search using auth token
39+
GH_TOKEN=<github_token> github-dork.py -u dev-nepal # search using auth token
4040

41-
GH_URL=https://github.example.com python github-dork.py -u dev-nepal # search a GitHub Enterprise instance
41+
GH_URL=https://github.example.com github-dork.py -u dev-nepal # search a GitHub Enterprise instance
4242
```
4343

4444
### Limitations

setup.py

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
from setuptools import setup
2+
3+
with open('README.md', 'r') as f:
4+
long_description = f.read()
5+
6+
setup(
7+
name='github-dorks',
8+
version='0.1',
9+
description='Find leaked secrets via github search.',
10+
license='Apache License 2.0',
11+
long_description=long_description,
12+
author='Samar Dhwoj Acharya (@techgaun)',
13+
long_description_content_type='text/markdown',
14+
scripts=['github-dork.py'],
15+
data_files=[('github-dorks', ['github-dorks.txt'])],
16+
install_requires=[
17+
'github3.py==1.0.0a2',
18+
'feedparser==6.0.2',
19+
],
20+
)

0 commit comments

Comments
 (0)