File tree Expand file tree Collapse file tree 1 file changed +29
-0
lines changed Expand file tree Collapse file tree 1 file changed +29
-0
lines changed Original file line number Diff line number Diff line change 1+ This repository is a Python 3.12+ network automation framework.
2+
3+ ## Architecture summary
4+ - ** FastAPI controller** exposes REST APIs and verifies API keys
5+ - ** Redis + RQ** handle task queuing and state storage
6+ - ** Manager** dispatches jobs to NodeWorker, FifoWorker and PinnedWorker
7+ - ** Plugin system** loads drivers, templates, schedulers and webhooks
8+ - ** Persistent SSH** connections boost performance
9+ - Deploy with Docker Compose or Kubernetes
10+
11+ ## Directory structure
12+ - ` netpulse/ ` - core code for server, workers and plugins
13+ - ` config/ ` - configuration files
14+ - ` docker/ ` - image build definitions
15+ - ` k8s/ ` - Kubernetes manifests
16+ - ` scripts/ ` - helper scripts
17+ - ` docs/ ` - documentation sources
18+ - ` redis/ ` - local Redis setup
19+ - ` build/ ` - build artifacts
20+
21+ ## Coding style
22+ - Format using ** Black** and lint with ** Ruff** (line length 100)
23+ - Follow PEP 8; use four-space indentation
24+ - Keep comments and docstrings short and in English
25+ - Use Pydantic models for data validation
26+ - Prefer explicit error handling and logging
27+ - New branch names must be English words or phrases
28+
29+ Use this summary to maintain consistency when extending the codebase.
You can’t perform that action at this time.
0 commit comments