feat: packaging

.prospector.yaml

@@ -11,6 +11,8 @@ pyroma:
 
 bandit:
   run: true
+  severity: LOW
+  confidence: LOW
 
 mypy:
   run: true

CONTRIBUTING.md

@@ -1,36 +1,17 @@
-# How To Contribute To Sherlock
-First off, thank you for the help!
+# Contributing
 
-There are many ways to contribute.  Here is some high level grouping.
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change.
 
-## Adding New Sites
+Please note we have a code of conduct, please follow it in all your interactions with the project.
 
-Please look at the Wiki entry on
-[adding new sites](https://github.com/sherlock-project/sherlock/wiki/Adding-Sites-To-Sherlock)
-to understand the issues.
+## Pull Request Process
 
-Any new sites that are added need to have a username that has been claimed, and one
-that is unclaimed documented in the site data.  This allows the regression tests
-to ensure that everything is working.
-
-It is required that a contributer test any new sites by either running the full tests, or running
-a site-specific query against the claimed and unclaimed usernames.
-
-It is not required that a contributer run the 
-[site_list.py](https://github.com/sherlock-project/sherlock/blob/master/site_list.py)
-script.
-
-If there are performance problems with a site (e.g. slow to respond, unreliable uptime, ...), then
-the site may be removed from the list.  The 
-[removed_sites.md](https://github.com/sherlock-project/sherlock/blob/master/removed_sites.md)
-file contains sites that were included at one time in Sherlock, but had to be removed for
-one reason or another.
-
-In regards to adult sites (e.g. Pornhub), we have agreed to not include them in Sherlock.  
-However, we do understand that some users desire this support.  The data.json file is easy to add to, 
-so users will be able to maintain their own forks to have this support. This is not ideal.  
-Maybe there could be another repo with an adult data.json? That would avoid forks getting out of date.
-
-## Adding New Functionality
-
-Please ensure that the content on your branch passes all tests before submitting a pull request.
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a
+   build.
+2. Update the README.md with details of changes to the interface, this includes new environment
+   variables, exposed ports, useful file locations and container parameters.
+3. Increase the version numbers in any examples files and the README.md to the new version that this
+   Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
+4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
+   do not have permission to do that, you may request the second reviewer to merge it for you.

MANIFEST.in

@@ -0,0 +1,2 @@
+include README.md
+include socialname/resources/data.json

Makefile

@@ -5,30 +5,25 @@ init:
 	pip install -r requirements-dev.txt
 
 
-
 lint:
 	make black
 	make flake8
 	make prospector
-	make hadolint
 black:
 	black socialname
 flake8:
 	flake8 --max-line-length=120 socialname
 prospector:
 	prospector socialname
-hadolint:
-	hadolint Dockerfile
-
 
 
 test:
 	tox --parallel
 coverage:
 	pytest --cov-config .coveragerc --verbose --cov-report term --cov-report html --cov=socialname tests
 
-
-
+sites:
+	python scripts/site_list.py
 publish:
 	pip install twine
 	python setup.py sdist bdist_wheel

README.md

@@ -1,64 +1,23 @@
-<p align=center>
-
-  <img src="https://user-images.githubusercontent.com/27065646/53551960-ae4dff80-3b3a-11e9-9075-cef786c69364.png"/>
-
-  <br>
-  <span>Hunt down social media accounts by username across <a href="https://github.com/sherlock-project/sherlock/blob/master/sites.md">social networks</a></span>
-  <br>
-  <a target="_blank" href="https://www.python.org/downloads/" title="Python version"><img src="https://img.shields.io/badge/python-%3E=_3.6-green.svg"></a>
-  <a target="_blank" href="LICENSE" title="License: MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg"></a>
-  <a target="_blank" href="https://github.com/sherlock-project/sherlock/actions" title="Test Status"><img src="https://github.com/sherlock-project/sherlock/workflows/Tests/badge.svg?branch=master"></a>
-  <a target="_blank" href="https://github.com/sherlock-project/sherlock/actions" title="Nightly Tests"><img src="https://github.com/sherlock-project/sherlock/workflows/Nightly/badge.svg?branch=master"></a>
-  <a target="_blank" href="https://twitter.com/intent/tweet?text=%F0%9F%94%8E%20Find%20usernames%20across%20social%20networks%20&url=https://github.com/sherlock-project/sherlock&hashtags=hacking,%20osint,%20bugbounty,%20reconnaissance" title="Share on Twitter"><img src="https://img.shields.io/twitter/url/http/shields.io.svg?style=social"></a>
-  <a target="_blank" href="http://sherlock-project.github.io/"><img alt="Website" src="https://img.shields.io/website-up-down-green-red/http/sherlock-project.github.io/..svg"></a>
-  <a target="_blank" href="https://microbadger.com/images/theyahya/sherlock"><img alt="docker image" src="https://images.microbadger.com/badges/version/theyahya/sherlock.svg"></a>
-</p>
-
-<p align="center">
-  <a href="#installation">Installation</a>
-  &nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
-  <a href="#usage">Usage</a>
-  &nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
-  <a href="#docker-notes">Docker Notes</a>
-  &nbsp;&nbsp;&nbsp;|&nbsp;&nbsp;&nbsp;
-  <a href="#contributing">Contributing</a>
-</p>
-
-<p align="center">
-<a href="https://asciinema.org/a/223115">
-<img src="./images/sherlock_demo.gif"/>
-</a>
-</p>
-
+# SocialName: Yet Another fork of Sherlock
 
 ## Installation
 
-```console
-# clone the repo
-$ git clone https://github.com/sherlock-project/sherlock.git
-
-# change the working directory to sherlock
-$ cd sherlock
-
-# install the requirements
-$ python3 -m pip install -r requirements.txt
+```bash
+$ pip install socialname
 ```
 
-
-[![Open in Cloud Shell](https://user-images.githubusercontent.com/27065646/92304704-8d146d80-ef80-11ea-8c29-0deaabb1c702.png)](https://console.cloud.google.com/cloudshell/open?git_repo=https://github.com/sherlock-project/sherlock&tutorial=README.md) [![Run on Repl.it](https://user-images.githubusercontent.com/27065646/92304596-bf719b00-ef7f-11ea-987f-2c1f3c323088.png)](https://repl.it/github/sherlock-project/sherlock)
-
 ## Usage
 
-```console
-$ python3 sherlock --help
-usage: sherlock [-h] [--version] [--verbose] [--folderoutput FOLDEROUTPUT]
+```bash
+$ socialname --help
+usage: socialname [-h] [--version] [--verbose] [--folderoutput FOLDEROUTPUT]
                 [--output OUTPUT] [--tor] [--unique-tor] [--csv]
                 [--site SITE_NAME] [--proxy PROXY_URL] [--json JSON_FILE]
                 [--timeout TIMEOUT] [--print-all] [--print-found] [--no-color]
                 [--browse] [--local]
                 USERNAMES [USERNAMES ...]
 
-Sherlock: Find Usernames Across Social Networks (Version 0.14.0)
+SocialName: Find Usernames Across Social Networks (Version 0.1.0)
 
 positional arguments:
   USERNAMES             One or more usernames to check with social networks.
@@ -97,113 +56,25 @@ optional arguments:
   --print-found         Output sites where the username was found.
   --no-color            Don't color terminal output
   --browse, -b          Browse to all results on default browser.
-  --local, -l           Force the use of the local data.json file.
+  --local, -l           Force the use of the local data.json file. (default True)
 ```
 
 To search for only one user:
-```
-python3 sherlock user123
-```
-
-To search for more than one user:
-```
-python3 sherlock user1 user2 user3
-```
-Or if usename contains spaces:
-```
-python3 sherlock "user with spaces"
-```
-
-Accounts found will be stored in an individual text file with the corresponding username (e.g ```user123.txt```).
-
-## Anaconda (Windows) Notes
-
-If you are using Anaconda in Windows, using 'python3' might not work. Use 'python' instead.
 
-## Docker Notes
-
-If docker is installed you can build an image and run this as a container.
-
-```
-docker build -t mysherlock-image .
-```
-
-Once the image is built, sherlock can be invoked by running the following:
-
-```
-docker run --rm -t mysherlock-image user123
+```bash
+$ socialname user123
 ```
 
-The optional ```--rm``` flag removes the container filesystem on completion to prevent cruft build-up. See: https://docs.docker.com/engine/reference/run/#clean-up---rm
-
-The optional ```-t``` flag allocates a pseudo-TTY which allows colored output. See: https://docs.docker.com/engine/reference/run/#foreground
-
-Use the following command to access the saved results:
-
-```
-docker run --rm -t -v "$PWD/results:/opt/sherlock/results" mysherlock-image -o /opt/sherlock/results/text.txt user123
-```
-
-The ```-v "$PWD/results:/opt/sherlock/results"``` options tell docker to create (or use) the folder `results` in the
-present working directory and to mount it at `/opt/sherlock/results` on the docker container.
-The `-o /opt/sherlock/results/text.txt` option tells `sherlock` to output the result.
-
-Or you can use "Docker Hub" to run `sherlock`:
-```
-docker run theyahya/sherlock user123
-```
-
-### Using `docker-compose`
-
-You can use the `docker-compose.yml` file from the repository and use this command:
+To search for more than one user:
 
+```bash
+$ socialname user1 user2 user3
 ```
-docker-compose run sherlock -o /opt/sherlock/results/text.txt user123
-```
-
-## Contributing
-We would love to have you help us with the development of Sherlock. Each and every contribution is greatly valued!
 
-Here are some things we would appreciate your help on:
-- Addition of new site support ¹
-- Bringing back site support of [sites that have been removed](removed_sites.md) in the past due to false positives
-
-
-[1] Please look at the Wiki entry on [adding new sites](https://github.com/sherlock-project/sherlock/wiki/Adding-Sites-To-Sherlock)
-to understand the issues.
-
-## Tests
-
-Thank you for contributing to Sherlock!
-
-Before creating a pull request with new development, please run the tests
-to ensure that everything is working great.  It would also be a good idea to run the tests
-before starting development to distinguish problems between your
-environment and the Sherlock software.
-
-The following is an example of the command line to run all the tests for
-Sherlock.  This invocation hides the progress text that Sherlock normally
-outputs, and instead shows the verbose output of the tests.
+Or if usename contains spaces:
 
+```bash
+$ socialname "user with spaces"
 ```
-$ cd sherlock/sherlock
-$ python3 -m unittest tests.all --verbose
-```
-
-Note that we do currently have 100% test coverage.  Unfortunately, some of
-the sites that Sherlock checks are not always reliable, so it is common
-to get response problems.  Any problems in connection will show up as
-warnings in the tests instead of true errors.
-
-If some sites are failing due to connection problems (site is down, in maintenance, etc)
-you can exclude them from tests by creating a `tests/.excluded_sites` file with a
-list of sites to ignore (one site name per line).
-
-## Stargazers over time
-
-[![Stargazers over time](https://starcharts.herokuapp.com/TheYahya/sherlock.svg)](https://starcharts.herokuapp.com/TheYahya/sherlock)
-
-## License
 
-MIT © Sherlock Project<br/>
-Original Creator - [Siddharth Dushantha](https://github.com/sdushantha)
+Accounts found will be stored in an individual text file with the corresponding username (e.g `user123.txt`).