jvspatial 0.0.1__tar.gz

jvspatial-0.0.1/.env.example

@@ -0,0 +1,493 @@
+# =============================================================================
+# jvspatial Environment Configuration Template
+# =============================================================================
+# Copy this file to .env and customize the values for your environment
+#
+# Usage:
+#   1. Copy: cp .env.example .env
+#   2. Edit the .env file with your specific configuration
+#   3. Load in your application: python-dotenv or similar
+#
+# =============================================================================
+
+# -----------------------------------------------------------------------------
+# API ROUTES CONFIGURATION
+# -----------------------------------------------------------------------------
+# Configure API endpoint prefixes and paths
+
+# API Prefix (prefix for all API endpoints)
+# Default: /api
+# Example: Change to /v1 for versioned API URLs
+# JVSPATIAL_API_PREFIX=/api
+
+# Health check endpoint path
+# Default: /health
+# JVSPATIAL_API_HEALTH=/health
+
+# Root endpoint path
+# Default: /
+# JVSPATIAL_API_ROOT=/
+
+# Storage endpoints prefix
+# Default: /storage
+# JVSPATIAL_STORAGE_PREFIX=/storage
+
+# Proxy endpoints prefix
+# Default: /p
+# JVSPATIAL_PROXY_PREFIX=/p
+
+# Example: Version your API
+# JVSPATIAL_API_PREFIX=/v1
+# Result: All endpoints will use /v1 instead of /api
+# - /v1/users/analyze instead of /api/users/analyze
+# - /v1/data/read instead of /api/data/read
+
+# -----------------------------------------------------------------------------
+# API SERVER CONFIGURATION
+# -----------------------------------------------------------------------------
+# Configure server host, port, and behavior
+
+# Server host address
+# Default: 0.0.0.0 (all interfaces)
+# JVSPATIAL_HOST=0.0.0.0
+
+# Server port
+# Default: 8000
+# JVSPATIAL_PORT=8000
+
+# Log level: debug, info, warning, error, critical
+# Default: info
+# JVSPATIAL_LOG_LEVEL=info
+
+# Debug mode: true, false
+# Default: false
+# JVSPATIAL_DEBUG=false
+
+# API title (shown in OpenAPI docs)
+# Default: jvspatial API
+# JVSPATIAL_API_TITLE=jvspatial API
+
+# API version (shown in OpenAPI docs)
+# Default: 1.0.0
+# JVSPATIAL_API_VERSION=1.0.0
+
+# API description (shown in OpenAPI docs)
+# Default: API built with jvspatial framework
+# JVSPATIAL_API_DESCRIPTION=API built with jvspatial framework
+
+# -----------------------------------------------------------------------------
+# CORS CONFIGURATION
+# -----------------------------------------------------------------------------
+# Configure Cross-Origin Resource Sharing
+
+# Enable CORS: true, false
+# Default: true
+# JVSPATIAL_CORS_ENABLED=true
+
+# CORS allowed origins (comma-separated)
+# Default: *
+# Examples:
+#   - Single origin: https://example.com
+#   - Multiple origins: https://example.com,https://app.example.com
+# JVSPATIAL_CORS_ORIGINS=*
+
+# CORS allowed methods (comma-separated)
+# Default: *
+# JVSPATIAL_CORS_METHODS=*
+
+# CORS allowed headers (comma-separated)
+# Default: *
+# JVSPATIAL_CORS_HEADERS=*
+
+# -----------------------------------------------------------------------------
+# DATABASE COLLECTION NAMES
+# -----------------------------------------------------------------------------
+# Customize collection names for different environments
+
+# User collection name
+# Default: users
+# JVSPATIAL_COLLECTION_USERS=users
+
+# API keys collection name
+# Default: api_keys
+# JVSPATIAL_COLLECTION_API_KEYS=api_keys
+
+# Sessions collection name
+# Default: sessions
+# JVSPATIAL_COLLECTION_SESSIONS=sessions
+
+# Webhooks collection name
+# Default: webhooks
+# JVSPATIAL_COLLECTION_WEBHOOKS=webhooks
+
+# Webhook requests collection name
+# Default: webhook_requests
+# JVSPATIAL_COLLECTION_WEBHOOK_REQUESTS=webhook_requests
+
+# Scheduled tasks collection name
+# Default: scheduled_tasks
+# JVSPATIAL_COLLECTION_SCHEDULED_TASKS=scheduled_tasks
+
+# -----------------------------------------------------------------------------
+# DATABASE CONFIGURATION
+# -----------------------------------------------------------------------------
+# Choose the database backend for jvspatial persistence
+
+# Database Type Selection
+# Options: 'json', 'mongodb'
+# Default: 'json' (if not specified)
+JVSPATIAL_DB_TYPE=json
+
+# -----------------------------------------------------------------------------
+# CACHING CONFIGURATION
+# -----------------------------------------------------------------------------
+# Configure caching strategy for improved performance
+# jvspatial supports multiple cache backends: memory, redis, and layered (L1+L2)
+
+# Cache Backend Selection
+# Options: 'memory', 'redis', 'layered'
+# - memory: Fast in-memory cache (single server)
+# - redis: Distributed Redis cache (multi-server)
+# - layered: Two-tier cache with memory (L1) + Redis (L2)
+# Default: Auto-detected ('layered' if Redis URL configured, otherwise 'memory')
+# JVSPATIAL_CACHE_BACKEND=memory
+
+# Cache Size (for memory and L1 cache)
+# Number of items to cache in memory
+# Higher values = better performance but more memory usage
+# Typical values:
+#   - Development: 500-1000
+#   - Production: 1000-5000
+#   - Memory-constrained: 100-500
+# Default: 1000
+JVSPATIAL_CACHE_SIZE=1000
+
+# L1 Cache Size (for layered cache)
+# Size of the fast in-memory L1 cache when using layered caching
+# Should be smaller than JVSPATIAL_CACHE_SIZE for hot data
+# Default: 500
+# JVSPATIAL_L1_CACHE_SIZE=500
+
+# Redis URL (for redis and layered backends)
+# Connection URL for Redis cache backend
+# Format: redis://[password@]host[:port][/database]
+# Examples:
+#   - redis://localhost:6379 (local, no auth)
+#   - redis://password@localhost:6379 (with password)
+#   - redis://redis-cache:6379/0 (custom host and database)
+#   - rediss://user:password@redis.example.com:6380 (SSL/TLS)
+# Default: redis://localhost:6379
+# JVSPATIAL_REDIS_URL=redis://localhost:6379
+
+# Redis TTL (Time-To-Live)
+# How long cached items remain in Redis (in seconds)
+# Set to 0 for no expiration (not recommended)
+# Default: 3600 (1 hour)
+# JVSPATIAL_REDIS_TTL=3600
+
+# -----------------------------------------------------------------------------
+# JSON DATABASE CONFIGURATION
+# -----------------------------------------------------------------------------
+# Used when JVSPATIAL_DB_TYPE=json (default backend)
+
+# Base path for JSON database files
+# The library will create subdirectories for different collections
+# Relative paths are relative to your application's working directory
+# Examples:
+#   - ./data/jvdb (relative path)
+#   - /var/lib/jvspatial/db (absolute path)
+#   - ~/jvspatial_data (home directory)
+JVSPATIAL_JSONDB_PATH=./jvdb
+
+# -----------------------------------------------------------------------------
+# MONGODB CONFIGURATION
+# -----------------------------------------------------------------------------
+# Used when JVSPATIAL_DB_TYPE=mongodb
+
+# MongoDB Connection URI
+# Format: mongodb://[username:password@]host[:port][/database][?options]
+# Examples:
+#   - mongodb://localhost:27017 (local, no auth)
+#   - mongodb://user:pass@localhost:27017 (local with auth)
+#   - mongodb+srv://user:pass@cluster.mongodb.net/ (MongoDB Atlas)
+#   - mongodb://mongo1,mongo2,mongo3:27017/?replicaSet=rs0 (replica set)
+JVSPATIAL_MONGODB_URI=mongodb://localhost:27017
+
+# MongoDB Database Name
+# The database within MongoDB instance to use for jvspatial data
+# Will be created automatically if it doesn't exist
+JVSPATIAL_MONGODB_DB_NAME=jvdb
+
+# -----------------------------------------------------------------------------
+# ENVIRONMENT-SPECIFIC EXAMPLES
+# -----------------------------------------------------------------------------
+
+# DEVELOPMENT ENVIRONMENT (Single server, memory cache)
+# Uncomment and modify for development setup:
+# JVSPATIAL_DB_TYPE=json
+# JVSPATIAL_JSONDB_PATH=./jvdb/dev
+# JVSPATIAL_CACHE_BACKEND=memory
+# JVSPATIAL_CACHE_SIZE=1000
+
+# TESTING ENVIRONMENT (Smaller cache for faster tests)
+# Uncomment and modify for testing setup:
+# JVSPATIAL_DB_TYPE=json
+# JVSPATIAL_JSONDB_PATH=./jvdb/test
+# JVSPATIAL_CACHE_BACKEND=memory
+# JVSPATIAL_CACHE_SIZE=100
+
+# PRODUCTION ENVIRONMENT (MongoDB + Layered cache with Redis)
+# Uncomment and modify for production setup:
+# JVSPATIAL_DB_TYPE=mongodb
+# JVSPATIAL_MONGODB_URI=mongodb+srv://production_user:secure_password@production-cluster.mongodb.net/
+# JVSPATIAL_MONGODB_DB_NAME=jvspatial_production
+# JVSPATIAL_CACHE_BACKEND=layered
+# JVSPATIAL_L1_CACHE_SIZE=500
+# JVSPATIAL_REDIS_URL=redis://redis-cache:6379
+# JVSPATIAL_REDIS_TTL=3600
+
+# KUBERNETES/DOCKER ENVIRONMENT (Multi-instance with Redis)
+# Uncomment and modify for Kubernetes/containerized setup:
+# JVSPATIAL_DB_TYPE=mongodb
+# JVSPATIAL_MONGODB_URI=mongodb://mongo_container:27017
+# JVSPATIAL_MONGODB_DB_NAME=jvspatial_docker
+# JVSPATIAL_CACHE_BACKEND=layered
+# JVSPATIAL_L1_CACHE_SIZE=500
+# JVSPATIAL_REDIS_URL=redis://redis-service:6379/0
+# JVSPATIAL_REDIS_TTL=3600
+
+# -----------------------------------------------------------------------------
+# WALKER INFINITE WALK PROTECTION
+# -----------------------------------------------------------------------------
+# Configure protection mechanisms to prevent infinite loops and runaway traversals
+
+# Enable/disable walker protection mechanisms
+# Options: true, false
+# Default: true
+JVSPATIAL_WALKER_PROTECTION_ENABLED=true
+
+# Maximum number of steps a walker can take before auto-halt
+# Set to 0 to disable step limit (not recommended)
+# Default: 10000
+JVSPATIAL_WALKER_MAX_STEPS=10000
+
+# Maximum times a single node can be visited before auto-halt
+# Prevents excessive cycles and infinite loops
+# Default: 100
+JVSPATIAL_WALKER_MAX_VISITS_PER_NODE=100
+
+# Maximum execution time in seconds before auto-halt
+# Prevents indefinitely running walkers
+# Default: 300.0 (5 minutes)
+JVSPATIAL_WALKER_MAX_EXECUTION_TIME=300.0
+
+# Maximum queue size before limiting new additions
+# Prevents memory overflow from excessive queuing
+# Default: 1000
+JVSPATIAL_WALKER_MAX_QUEUE_SIZE=1000
+
+# -----------------------------------------------------------------------------
+# ENVIRONMENT-SPECIFIC PROTECTION EXAMPLES
+# -----------------------------------------------------------------------------
+
+# DEVELOPMENT ENVIRONMENT (More permissive)
+# JVSPATIAL_WALKER_MAX_STEPS=50000
+# JVSPATIAL_WALKER_MAX_VISITS_PER_NODE=200
+# JVSPATIAL_WALKER_MAX_EXECUTION_TIME=600.0
+
+# TESTING ENVIRONMENT (Stricter limits for faster test execution)
+# JVSPATIAL_WALKER_MAX_STEPS=1000
+# JVSPATIAL_WALKER_MAX_VISITS_PER_NODE=10
+# JVSPATIAL_WALKER_MAX_EXECUTION_TIME=30.0
+
+# PRODUCTION ENVIRONMENT (Balanced limits)
+# JVSPATIAL_WALKER_MAX_STEPS=10000
+# JVSPATIAL_WALKER_MAX_VISITS_PER_NODE=100
+# JVSPATIAL_WALKER_MAX_EXECUTION_TIME=300.0
+
+# -----------------------------------------------------------------------------
+# WEBHOOK CONFIGURATION
+# -----------------------------------------------------------------------------
+# Configure webhook processing, security, and performance settings
+
+# Global HMAC Secret for Webhook Verification
+# Use a cryptographically secure secret (minimum 32 characters)
+# Can be overridden per-endpoint in decorator parameters
+# Example: openssl rand -hex 32
+JVSPATIAL_WEBHOOK_HMAC_SECRET=your-webhook-hmac-secret-replace-in-production
+
+# HMAC Algorithm for Signature Verification
+# Options: sha256, sha1, sha512
+# Default: sha256 (recommended)
+JVSPATIAL_WEBHOOK_HMAC_ALGORITHM=sha256
+
+# Maximum Webhook Payload Size (bytes)
+# Prevents memory exhaustion from large payloads
+# Default: 1048576 (1MB)
+JVSPATIAL_WEBHOOK_MAX_PAYLOAD_SIZE=1048576
+
+# Webhook Idempotency TTL (seconds)
+# How long to store idempotency keys for duplicate detection
+# Default: 3600 (1 hour)
+JVSPATIAL_WEBHOOK_IDEMPOTENCY_TTL=3600
+
+# Require HTTPS for Webhook Endpoints
+# Options: true, false
+# Default: true (highly recommended for production)
+JVSPATIAL_WEBHOOK_HTTPS_REQUIRED=true
+
+# Service-Specific Webhook Secrets (Optional)
+# These override the global HMAC secret for specific services
+# JVSPATIAL_WEBHOOK_STRIPE_SECRET=whsec_your_stripe_webhook_secret
+# JVSPATIAL_WEBHOOK_GITHUB_SECRET=your_github_webhook_secret
+# JVSPATIAL_WEBHOOK_SLACK_SECRET=your_slack_webhook_secret
+
+# -----------------------------------------------------------------------------
+# AUTHENTICATION & JWT CONFIGURATION
+# -----------------------------------------------------------------------------
+# Configure user authentication, JWT tokens, and API security
+
+# JWT Secret Key for Token Signing
+# Use a cryptographically secure secret (minimum 32 characters)
+# CRITICAL: Change this in production!
+# Example: python -c "import secrets; print(secrets.token_urlsafe(32))"
+JVSPATIAL_JWT_SECRET_KEY=your-jwt-secret-key-replace-in-production
+
+# JWT Algorithm for Token Signing
+# Options: HS256, HS384, HS512, RS256, etc.
+# Default: HS256
+JVSPATIAL_JWT_ALGORITHM=HS256
+
+# JWT Token Expiration (hours)
+# How long access tokens remain valid
+# Default: 24 hours
+JVSPATIAL_JWT_EXPIRATION_HOURS=24
+
+# JWT Refresh Token Expiration (days)
+# How long refresh tokens remain valid
+# Default: 30 days
+JVSPATIAL_JWT_REFRESH_EXPIRATION_DAYS=30
+
+# API Key Configuration
+# Header name for API key authentication
+JVSPATIAL_API_KEY_HEADER=X-API-Key
+
+# Query parameter name for API key authentication
+JVSPATIAL_API_KEY_QUERY_PARAM=api_key
+
+# Rate Limiting Configuration
+# Enable/disable rate limiting
+# Options: true, false
+# Default: true
+JVSPATIAL_RATE_LIMIT_ENABLED=true
+
+# Default rate limit per hour for authenticated users
+# Default: 1000 requests per hour
+JVSPATIAL_DEFAULT_RATE_LIMIT_PER_HOUR=1000
+
+# Security Configuration
+# Require HTTPS for authentication endpoints
+# Options: true, false
+# Default: true (required for production)
+JVSPATIAL_REQUIRE_HTTPS=true
+
+# Session Cookie Security
+# Make session cookies secure (HTTPS only)
+# Options: true, false
+# Default: true
+JVSPATIAL_SESSION_COOKIE_SECURE=true
+
+# Session Cookie HTTP Only
+# Prevent JavaScript access to session cookies
+# Options: true, false
+# Default: true
+JVSPATIAL_SESSION_COOKIE_HTTPONLY=true
+
+# -----------------------------------------------------------------------------
+# FILE STORAGE CONFIGURATION
+# -----------------------------------------------------------------------------
+# Configure file storage backend and settings
+
+# Enable/disable file storage
+# Options: true, false
+# Default: false
+JVSPATIAL_FILE_STORAGE_ENABLED=false
+
+# File storage provider
+# Options: 'local' or 's3'
+# Default: 'local'
+JVSPATIAL_FILE_STORAGE_PROVIDER=local
+
+# Root directory for local file storage
+# Default: '.files'
+JVSPATIAL_FILE_STORAGE_ROOT=.files
+
+# Base URL for file access
+# Default: 'http://localhost:8000'
+JVSPATIAL_FILE_STORAGE_BASE_URL=http://localhost:8000
+
+# Maximum file size in bytes
+# Default: 104857600 (100MB)
+JVSPATIAL_FILE_STORAGE_MAX_SIZE=104857600
+
+# S3 Configuration (when using 's3' provider)
+JVSPATIAL_S3_BUCKET_NAME=your-bucket-name
+JVSPATIAL_S3_REGION=us-east-1
+JVSPATIAL_S3_ACCESS_KEY=your-access-key
+JVSPATIAL_S3_SECRET_KEY=your-secret-key
+JVSPATIAL_S3_ENDPOINT_URL=https://s3.amazonaws.com
+
+# URL Proxy Configuration
+# Enable URL proxy system for short URLs
+# Default: false
+JVSPATIAL_PROXY_ENABLED=false
+
+# Default proxy URL expiration in seconds
+# Default: 3600 (1 hour)
+JVSPATIAL_PROXY_DEFAULT_EXPIRATION=3600
+
+# Maximum proxy URL expiration in seconds
+# Default: 86400 (24 hours)
+JVSPATIAL_PROXY_MAX_EXPIRATION=86400
+
+# -----------------------------------------------------------------------------
+# ENVIRONMENT-SPECIFIC WEBHOOK EXAMPLES
+# -----------------------------------------------------------------------------
+
+# DEVELOPMENT ENVIRONMENT (Relaxed security for testing)
+# JVSPATIAL_WEBHOOK_HTTPS_REQUIRED=false
+# JVSPATIAL_WEBHOOK_HMAC_SECRET=dev-webhook-secret-not-for-production
+# JVSPATIAL_JWT_SECRET_KEY=dev-jwt-secret-not-for-production
+# JVSPATIAL_REQUIRE_HTTPS=false
+# JVSPATIAL_SESSION_COOKIE_SECURE=false
+
+# TESTING ENVIRONMENT (Minimal security for fast tests)
+# JVSPATIAL_WEBHOOK_HTTPS_REQUIRED=false
+# JVSPATIAL_WEBHOOK_IDEMPOTENCY_TTL=60
+# JVSPATIAL_JWT_EXPIRATION_HOURS=1
+# JVSPATIAL_RATE_LIMIT_ENABLED=false
+
+# PRODUCTION ENVIRONMENT (Maximum security)
+# JVSPATIAL_WEBHOOK_HTTPS_REQUIRED=true
+# JVSPATIAL_WEBHOOK_HMAC_SECRET=prod-webhook-secret-64-chars-minimum
+# JVSPATIAL_JWT_SECRET_KEY=prod-jwt-secret-64-chars-minimum
+# JVSPATIAL_REQUIRE_HTTPS=true
+# JVSPATIAL_SESSION_COOKIE_SECURE=true
+# JVSPATIAL_DEFAULT_RATE_LIMIT_PER_HOUR=500
+
+# -----------------------------------------------------------------------------
+# SECURITY NOTES
+# -----------------------------------------------------------------------------
+#
+# 1. CRITICAL: Never commit .env files with real secrets to version control
+# 2. Use cryptographically secure secrets (minimum 32 characters)
+# 3. Rotate secrets regularly in production
+# 4. Use strong passwords for MongoDB authentication
+# 5. Restrict MongoDB network access in production
+# 6. Use MongoDB Atlas or properly secured self-hosted instances
+# 7. Consider using secrets management in production (AWS Secrets Manager, etc.)
+# 8. Enable HTTPS in production for all authentication endpoints
+# 9. Use secure session cookies in production
+# 10. Monitor webhook endpoints for suspicious activity
+#
+# -----------------------------------------------------------------------------

jvspatial-0.0.1/.flake8

@@ -0,0 +1,15 @@
+[flake8]
+max-line-length = 88
+extend-ignore = E203, E266, E501, W503, ANN101, ANN102, ANN204, ANN201, ANN001, ANN003, ANN202, D107, D202, D401
+exclude =
+    .git,
+    __pycache__,
+    .venv,
+    .pytest_cache,
+    .vscode,
+    build,
+    dist,
+    docs,
+    migrations
+per-file-ignores =
+    tests/*: E402

jvspatial-0.0.1/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,33 @@
+---
+name: Bug report
+about: Create a report to report any bugs in jvspatial
+title: "[BUG]: "
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment (please complete the following information):**
+ - Python Version [e.g. 3.12]
+ - Jaclang Version [e.g. 0.7.27]
+ - Jivas Version [e.g. 2.0.0]
+- jvspatial Version [e.g 0.0.1]
+
+**Additional context**
+Add any other context about the problem here.

jvspatial-0.0.1/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for jvspatial
+title: "[Feature Request]: "
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

jvspatial-0.0.1/.github/ISSUE_TEMPLATE/refactor-request.md

@@ -0,0 +1,40 @@
+---
+name: Refactor Request
+about: Request a refactor to core jvspatial functionality
+title: "[Refactor Request]: "
+labels: ''
+assignees: ''
+
+---
+
+## Summary
+Provide a brief description of the refactor you are proposing. Focus on the high-level goal of the change.
+
+## Current Problem
+Describe the current issues with the existing code. Examples:
+- Poor readability or maintainability
+- Duplication of code
+- Performance bottlenecks
+- Lack of extensibility
+
+## Proposed Solution
+Explain the refactor you are suggesting:
+- Outline how the code will be reorganized, improved, or optimized.
+- Specify any best practices or patterns you aim to implement.
+- Highlight tools, libraries, or approaches you plan to leverage.
+
+## Expected Benefits
+Describe the outcomes and benefits of this refactor:
+- Enhanced code quality
+- Improved maintainability
+- Better performance
+- Simplified debugging or testing
+
+## Scope of Changes
+List the modules, files, or components that are likely to be impacted:
+- [ ] Module/File 1
+- [ ] Module/File 2
+- [ ] Component 3
+
+## Additional Notes
+Include any additional context or examples that will help clarify the refactor. Add links to related issues, discussions, or documentation, if applicable.

jvspatial-0.0.1/.github/pull_request_template.md

@@ -0,0 +1,76 @@
+## **Type of Change**
+What type of change does this PR introduce? Mark all that apply:
+- [ ] 🐛 Bug Fix
+- [ ] 🚀 Feature Request
+- [ ] 🔄 Refactor
+- [ ] 📖 Documentation Update
+- [ ] 🔧 Other (Please specify):
+
+---
+
+## **Summary**
+### **What does this PR address?**
+Provide a concise summary of the changes introduced in this pull request. Specify if it resolves an issue, adds a feature, or refactors code.
+
+For example:
+- Resolves #ISSUE_ID
+- Adds feature for X
+- Refactors Y to improve Z
+
+---
+
+## **Description**
+### **Bug Fixes**:
+If this PR fixes a bug, please provide:
+- A brief description of the bug.
+- The root cause of the issue.
+- How this PR resolves the issue.
+
+### **Feature Request**:
+If this PR adds a new feature, please provide:
+- A brief description of the feature.
+- The motivation for introducing it.
+- Any relevant details about implementation.
+
+### **Refactor Request**:
+If this PR refactors code, please provide:
+- The specific area of code refactored.
+- The problem with the current implementation.
+- The improvements made in the refactor.
+
+---
+
+## **Changes Made**
+### High-Level Summary:
+List the key changes made in this PR:
+1. Change 1
+2. Change 2
+3. Change 3
+
+---
+
+## **Checklist**
+Mark all that apply:
+- [ ] Code follows the project’s coding guidelines.
+- [ ] Tests have been added or updated for new functionality.
+- [ ] Documentation has been updated (if applicable).
+- [ ] Existing tests pass locally with these changes.
+- [ ] Any dependencies introduced are justified and documented.
+
+---
+
+## **Steps to Test**
+Provide a clear set of steps for testing the changes introduced in this PR:
+1. Step 1
+2. Step 2
+3. Step 3
+
+---
+
+## **Additional Context**
+If necessary, provide additional context, screenshots, or relevant references for the changes in this PR.
+
+---
+
+## **Questions or Concerns**
+Are there any open questions or areas of concern related to this PR? If so, mention them here.

jvspatial-0.0.1/.github/release.yml

@@ -0,0 +1,7 @@
+# .github/release.yml
+
+changelog:
+  categories:
+    - title: 🚀 Features | Bug Fixes 🐛 | Refactor 🔄
+      labels:
+        - '*'