feat: new update

Author: lekanjava

CONTRIBUTING.md

@@ -5,10 +5,10 @@ Thank you for your interest in contributing! We welcome contributions from devel
 ## 🚀 Quick Start
 
 1. **Fork** the repository
-2. **Clone** your fork: `git clone https://github.com/zeemscript/vulnscanner.git`
+2. **Clone** your fork: `git clone https://github.com/yourusername/vulnscanner.git`
 3. **Create** a feature branch: `git checkout -b feature/amazing-feature`
 4. **Make** your changes
-5. **Test** your changes: `pip install -e . && vulnscan --help`
+5. **Test** your changes: `python test_scanner.py`
 6. **Commit** your changes: `git commit -m 'Add amazing feature'`
 7. **Push** to your branch: `git push origin feature/amazing-feature`
 8. **Open** a Pull Request
@@ -26,17 +26,17 @@ Thank you for your interest in contributing! We welcome contributions from devel
 
 ```bash
 # Clone repository
-git clone https://github.com/zeemscript/vulnscanner.git
+git clone https://github.com/yourusername/vulnscanner.git
 cd vulnscanner
 
-# Install in development mode
-pip install -e .
+# Install dependencies
+pip install -r requirements.txt
 
-# Test installation
-vulnscan --help
+# Run tests
+python test_scanner.py
 
 # Test scanner
-vulnscan httpbin.org --scan-types web --timeout 10
+python main.py httpbin.org --scan-types web --timeout 10
 ```
 
 ### Docker Setup
@@ -45,8 +45,8 @@ vulnscan httpbin.org --scan-types web --timeout 10
 # Build image
 docker build -t vulnscanner .
 
-# Test installation
-docker run --rm vulnscanner vulnscan --help
+# Run tests
+docker run --rm vulnscanner python test_scanner.py
 ```
 
 ## 📋 Contribution Guidelines

MANIFEST.in

@@ -11,3 +11,4 @@ global-exclude __pycache__
 global-exclude .git*
 global-exclude .DS_Store
 global-exclude *.egg-info
+

Makefile

@@ -0,0 +1,86 @@
+# VulnScan AI Makefile
+# Easy commands for development and testing
+
+.PHONY: help install test lint format security clean docker-build docker-run
+
+# Default target
+help:
+	@echo "VulnScan AI - Available Commands:"
+	@echo ""
+	@echo "Development:"
+	@echo "  install     - Install basic dependencies"
+	@echo "  install-full - Install all dependencies (including dev tools)"
+	@echo "  install-dev - Install in development mode"
+	@echo "  test        - Run tests"
+	@echo "  test-with-coverage - Run tests with coverage report"
+	@echo "  lint        - Run linting"
+	@echo "  format      - Format code"
+	@echo "  security    - Run security checks"
+	@echo ""
+	@echo "Docker:"
+	@echo "  docker-build - Build Docker image"
+	@echo "  docker-run   - Run Docker container"
+	@echo ""
+	@echo "Utilities:"
+	@echo "  clean       - Clean up generated files"
+	@echo "  scan-example - Run example scan"
+
+# Development commands
+install:
+	pip install -r requirements-basic.txt
+
+install-full:
+	pip install -r requirements.txt
+
+install-dev:
+	pip install -r requirements.txt
+	pip install -e .
+
+test:
+	pytest tests/ -v
+
+test-with-coverage:
+	pytest tests/ -v --cov=vulnscan_ai --cov-report=term-missing
+
+test-fast:
+	pytest tests/ -v -m "not slow"
+
+lint:
+	flake8 vulnscan_ai/ tests/
+	mypy vulnscan_ai/
+
+format:
+	black vulnscan_ai/ tests/
+	isort vulnscan_ai/ tests/
+
+security:
+	safety check
+	bandit -r vulnscan_ai/
+
+# Docker commands
+docker-build:
+	docker build -t vulnscan-ai .
+
+docker-run:
+	docker run --rm -it vulnscan-ai
+
+# Example scan
+scan-example:
+	python -m vulnscan_ai.main httpbin.org --scan-types web ssl --output json
+
+# Clean up
+clean:
+	find . -type f -name "*.pyc" -delete
+	find . -type d -name "__pycache__" -delete
+	find . -type d -name "*.egg-info" -exec rm -rf {} +
+	rm -rf build/
+	rm -rf dist/
+	rm -rf htmlcov/
+	rm -rf .coverage
+	rm -rf .pytest_cache/
+
+# Full development setup
+setup: install-dev
+	@echo "Setting up development environment..."
+	@echo "Copy env.example to .env and update with your API keys"
+	@echo "Run 'make test' to verify installation"

README.md

@@ -26,6 +26,23 @@ A lightweight, AI-powered vulnerability scanner that helps developers identify s
 pip install vulnscan-ai
 ```
 
+### Development Installation
+
+```bash
+# Clone the repository
+git clone https://github.com/zeemscript/vulnscanner.git
+cd vulnscanner
+
+# Install in development mode
+make install-dev
+
+# Run tests
+make test
+
+# Run example scan
+make scan-example
+```
+
 ### Basic Usage
 
 ```bash
@@ -37,6 +54,9 @@ vulnscan example.com --scan-types web ssl --output html
 
 # High-performance scanning
 vulnscan example.com --threads 20 --batch-size 50
+
+# Interactive mode with guided scanning
+vulnscan --interactive
 ```
 
 ## 🎯 Essential Commands

env.example

@@ -0,0 +1,19 @@
+# VulnScan AI Configuration
+# Copy this file to .env and update with your values
+
+# API Keys (Optional - for enhanced scanning)
+SHODAN_API_KEY=your_shodan_api_key_here
+VIRUSTOTAL_API_KEY=your_virustotal_api_key_here
+
+# Scanner Configuration
+VULNSCANNER_THREADS=10
+VULNSCANNER_TIMEOUT=30
+VULNSCANNER_USER_AGENT=Mozilla/5.0 (compatible; VulnScanner/1.0)
+
+# Logging Configuration
+VULNSCANNER_LOG_LEVEL=INFO
+VULNSCANNER_LOG_FILE=logs/vulnscan.log
+
+# Security Settings
+VULNSCANNER_MAX_SCAN_DURATION=3600
+VULNSCANNER_RATE_LIMIT=100

pytest.ini

@@ -0,0 +1,14 @@
+[tool:pytest]
+testpaths = tests
+python_files = test_*.py
+python_classes = Test*
+python_functions = test_*
+addopts = 
+    -v
+    --tb=short
+    --strict-markers
+    --disable-warnings
+markers =
+    slow: marks tests as slow (deselect with '-m "not slow"')
+    integration: marks tests as integration tests
+    unit: marks tests as unit tests

tests/__init__.py

@@ -0,0 +1 @@
+# Tests package for VulnScan AI