This page describe the project structure and gives you a bit of help to start contributing.
The project is maintained by a single person: sundowndev. Contributions are welcome !
!!! tip "Want to contribute ? Clone the project and open some pull requests !"
See the installation page to install the project.
$ tree . -I __pycache__
├── docs
├── examples
│ ├── generate.sh
│ ├── input.txt
│ ├── output_from_input.txt
│ └── output_single.txt
├── lib
│ ├── args.py
│ ├── banner.py
│ ├── colors.py
│ ├── format.py
│ ├── googlesearch.py
│ ├── __init__.py
│ ├── logger.py
│ ├── output.py
│ └── request.py
├── osint
├── scanners
│ ├── footprints.py
│ ├── __init__.py
│ ├── localscan.py
│ ├── numverify.py
│ ├── ovh.py
│ └── recon.py
├── config.example.py
├── Dockerfile
├── mkdocs.yml
├── phoneinfoga.py
└── requirements.txt
We use Green to run unit tests.
# Install green
python -m pip install green
# Run unit tests
python -m green tests/**/*.py -r -vvv We use Black code formatter to format Python files.
# Install Black
python -m pip install black
# Check file formats using Black
python -m black --config black.config.toml lib scanners tests --check
# Format files using Black
python -m black --config black.config.toml lib scanners testsWe use mkdocs to write our documentation.
python3 -m pip install mkdocs
mkdocs serve
mkdocs gh-deploy