Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ChrisCarini/shodan-exposure-box

Update a gist to contain Shodan.io Exposure Stats
https://github.com/ChrisCarini/shodan-exposure-box

pinned pinned-gist shodan

Last synced: 6 days ago
JSON representation

Update a gist to contain Shodan.io Exposure Stats

Awesome Lists containing this project

README

        



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

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

### Saving Dependencies

```shell
source activate
pip-chill > requirements.txt
```

### Running linting and tests

```shell
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/
```