README.md

January 25, 2022 ยท View on GitHub

shodan-exposure-box

๐Ÿ’ป Update a pinned gist to contain Shodan.io Exposure Stats

Update a pinned gist to contain Shodan.io Exposure Stats Lint & Test

๐ŸŽ’ Prep Work

  1. Create a new public GitHub Gist (https://gist.github.com/)
  2. Create a token with the gist scope and copy it. (https://github.com/settings/tokens/new)
  3. Copy the API token

๐Ÿ–ฅ Project Setup

  1. Go to your fork's Settings > Secrets > Add a new secret for each environment secret (below)

๐Ÿคซ Environment Secrets

  • GH_TOKEN: The GitHub token generated above.

  • GIST_ID: The ID portion from your gist url:

    https://gist.github.com/ChrisCarini/0c0b8690e430b9fe4572f9c4a38811c1.

    (Alternatively this can be put directly in .github/workflows/shodan.yml as it is public anyway.)

๐Ÿค“ Hacking

Getting Setup

python3 -m venv venv
source activate
pip install -r requirements.txt

Saving Dependencies

source activate
pip-chill > requirements.txt

Running linting and tests

isort main.py shodan.py test/ && \
mypy main.py shodan.py test/ && \
flake8 main.py shodan.py test/ && \
blue --check main.py shodan.py test/ && \
pytest test/