Port Scanner

My basic port scanner. Used as an experience project to better my understanding of the basics of cyber security!

Included:

• Packaging via pyproject.toml
• Developer dependencies via requirements-dev.txt
• Formatting and linting via ruff
• Type checking via mypy
• Test runner via pytest
• Pre-commit hooks via pre-commit
• CI workflow via GitHub Actions
• License file for reuse

How to use:

1. Clone and enter the project (you know this one)

2. Create and activate a virtual environment

python3 -m venv .venv
source .venv/bin/activate

3. Install development dependencies

python3 -m pip install --upgrade pip
python3 -m pip install -r requirements-dev.txt
pre-commit install

Development Commands

Run these directly or via make shortcuts.

make format      # Format code
make lint        # Lint code
make typecheck   # Run mypy
make test        # Run tests
make check       # Lint + typecheck + tests
make run         # Run scanner.py

Equivalent direct commands:

ruff format .
ruff check .
mypy scanner.py
pytest
python3 scanner.py

Project Layout

Port-Scanner/
	.github/workflows/ci.yml
	.pre-commit-config.yaml
	LICENSE
	Makefile
	pyproject.toml
	README.md
	requirements-dev.txt
	scanner.py
	tests/

Notes

• scanner.py is the intended entry point for your scanner logic.
• The scaffold is ready for contributors to clone, install, and run quality checks consistently.