Skip to content

Commit 86f2181

Browse files
committed
chore: sync shared files and documentation across all repositories
- Updated shared templates from repo-utils-shared - Synced README.md and TODO.md per repo type - Replaced .github workflows with common versions - Ensured consistent Makefile, pre-commit, and linting configs
1 parent 5a54d3d commit 86f2181

File tree

4 files changed

+10
-96
lines changed

4 files changed

+10
-96
lines changed

.github/workflows/Dependency Security Audit.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,5 +20,6 @@ jobs:
2020
echo "✅ Full dependency audit succeeded."
2121
else
2222
echo "⚠️ Full audit failed due to dependency resolution. Falling back to direct-only audit..."
23-
pip-audit --no-deps --requirement requirements.txt --requirement requirements-dev.txt
23+
pip-audit --no-deps --requirement requirements.txt
24+
pip-audit --no-deps --requirement requirements-dev.txt
2425
fi

.github/workflows/SBOM and License Audit.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ jobs:
99
name: Generate SBOM & License Report
1010
runs-on: ubuntu-latest
1111
permissions:
12-
contents: read
12+
contents: read
1313
steps:
1414
- uses: actions/checkout@v4
1515
- name: Set up Python

README.md

Lines changed: 2 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,3 @@
1-
# Stock Analysis Engine
1+
# Analysis Engine
22

3-
This repository processes raw market data and produces actionable insights or
4-
computed indicators using technical, quantitative, or alternative methods.
5-
6-
## Features
7-
8-
- Supports multiple analysis strategies (technical, factor-based, alt-data)
9-
- Pluggable processor functions per indicator type
10-
- Queue-driven or database-driven architecture
11-
- Structured output schema for downstream consumption
12-
- Fully containerized with support for Kubernetes
13-
- Structured logging and metric-ready instrumentation
14-
15-
## Project Structure
16-
17-
```
18-
src/
19-
├── app/
20-
│ ├── config.py
21-
│ ├── main.py
22-
│ ├── queue_handler.py # Consumes messages and dispatches to processor
23-
│ ├── processor.py # Core analysis logic
24-
│ ├── output_handler.py # Writes to queue or database
25-
│ └── utils/
26-
```
27-
28-
## Usage
29-
30-
```bash
31-
make install
32-
make run
33-
```
34-
35-
## Environment Variables
36-
37-
| Variable | Description |
38-
| ------------- | ---------------------------------- |
39-
| `QUEUE_TYPE` | Input source: `rabbitmq` or `sqs` |
40-
| `OUTPUT_TYPE` | Output mode: `db`, `queue`, `rest` |
41-
| `VAULT_ADDR` | Vault server address |
42-
| `VAULT_TOKEN` | Vault token or AppRole auth config |
43-
44-
## Development
45-
46-
```bash
47-
make lint
48-
make test
49-
make build
50-
```
51-
52-
## License
53-
54-
Apache License 2.0
3+
TODO: Describe analysis strategy and models.

TODO.md

Lines changed: 5 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,45 +1,9 @@
1-
# TODO — Stock Analysis Engine
1+
# TODO for Analysis Engine
22

3-
## 🧩 Missing Features
3+
## 1. Feature Engineering
44

5-
- [ ] Add new analysis models (momentum, mean reversion, ML-based)
6-
- [ ] Enable hybrid models using combined signal weighting
7-
- [ ] Support windowed multi-frame analysis (e.g., 5m + 1h + 1d)
8-
- [ ] Dynamic rule-based output routing (e.g., signal only on threshold)
5+
- [ ] Add rolling averages, volatility, momentum indicators
96

10-
## 🛠️ Infrastructure Enhancements
7+
## 2. Output
118

12-
- [ ] Retry logic in queue and output handlers
13-
- [ ] Full output schema validation using Pydantic
14-
- [ ] Prometheus metrics integration (processing latency, error rate)
15-
- [ ] Output to InfluxDB/PostgreSQL with async support (future)
16-
17-
## 📈 Monitoring & Logging
18-
19-
- [ ] Use JSON logs with field-level detail
20-
- [ ] Add structured error tracking for processor exceptions
21-
- [ ] Implement message trace ID propagation
22-
23-
## ✅ Security & Compliance
24-
25-
- [ ] Bandit + Safety CI enforcement
26-
- [ ] Cosign image signing & SBOM
27-
- [ ] Add REUSE headers & license validation
28-
- [ ] Add Semgrep rules for static analysis
29-
30-
## 🧪 Testing & CI
31-
32-
- [ ] Full test coverage of processor modules
33-
- [ ] Test queue parsing edge cases
34-
- [ ] Enforce pre-commit consistency with CI
35-
36-
## 🧹 Code Hygiene
37-
38-
- [ ] Remove unused imports and legacy code
39-
- [ ] Verify typing coverage (`pyright`, `mypy`)
40-
- [ ] Regenerate missing docstrings with `pyment`
41-
42-
## 🪄 Optional Enhancements
43-
44-
- [ ] Add CLI runner for local batch analysis
45-
- [ ] Stream results to WebSocket or dashboard frontend
9+
- [ ] Write to queue or DB

0 commit comments

Comments
 (0)