Comprehensive README rewrite + community files
- Full 'What Is OrderFlow Analysis?' section explaining microstructure concepts - System overview with ASCII architecture diagram - Detailed data flow pipeline showing all engines and detectors - Module dependency graph with line counts - 5 Core Patterns: detection logic, strength formulas, source data table - Volume Profile Framing: ASCII shape diagrams (P/b/D/Double), qualified levels - State Machine: full lifecycle diagram with all transitions - 29 instruments with per-instrument threshold tables (indices, metals, forex, stocks, crypto) - Dual data feed architecture diagram (MT5 + Bybit) - Dashboard: 8 JS component layout, 9 WebSocket channels with throttling - Database: full 5-table schema diagram - API reference: 16 REST endpoints + strategy status labels + scanner priority scoring - Demo mode documentation with signal quality grading (A+/A/B/C) - Pattern detection deep-dive (absorption 2-method, initiative 5-criteria) - Composite scoring system breakdown with SL/TP calculation table - Signal output examples (entry, daily bias, strategy status) - Badges: Python 3.10+, MIT, 29 instruments, ~12K lines, 16 API endpoints - Added: LICENSE (MIT), CONTRIBUTING.md, issue templates (bug, feature, new instrument), PR template
This commit is contained in:
@@ -0,0 +1,31 @@
|
||||
---
|
||||
name: Bug Report
|
||||
about: Report a bug or unexpected behavior
|
||||
title: "[BUG] "
|
||||
labels: bug
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
What went wrong?
|
||||
|
||||
## Steps to Reproduce
|
||||
|
||||
1. ...
|
||||
2. ...
|
||||
3. ...
|
||||
|
||||
## Expected Behavior
|
||||
|
||||
What should have happened?
|
||||
|
||||
## Environment
|
||||
|
||||
- Data source: [MT5 / Bybit / Both]
|
||||
- Python version:
|
||||
- OS:
|
||||
- Any error messages:
|
||||
|
||||
## Instrument (if applicable)
|
||||
|
||||
Which instrument(s) were affected?
|
||||
@@ -0,0 +1,22 @@
|
||||
---
|
||||
name: Feature Request
|
||||
about: Suggest a new feature or enhancement
|
||||
title: "[FEATURE] "
|
||||
labels: enhancement
|
||||
---
|
||||
|
||||
## Description
|
||||
|
||||
What feature would you like to see?
|
||||
|
||||
## Use Case
|
||||
|
||||
How would this feature be used?
|
||||
|
||||
## Suggested Implementation
|
||||
|
||||
Any ideas on how to implement it?
|
||||
|
||||
## Related
|
||||
|
||||
Any related issues or PRs?
|
||||
@@ -0,0 +1,29 @@
|
||||
---
|
||||
name: New Instrument
|
||||
about: Request support for a new instrument
|
||||
title: "[INSTRUMENT] "
|
||||
labels: enhancement
|
||||
---
|
||||
|
||||
## Instrument
|
||||
|
||||
Name and exchange/broker:
|
||||
|
||||
## Category
|
||||
|
||||
- [ ] Index
|
||||
- [ ] Forex
|
||||
- [ ] Metal
|
||||
- [ ] Energy
|
||||
- [ ] Stock
|
||||
- [ ] Crypto
|
||||
- [ ] Other
|
||||
|
||||
## Suggested Thresholds
|
||||
|
||||
If you have experience with this instrument, suggest values:
|
||||
|
||||
- Absorption min volume:
|
||||
- Initiative min delta:
|
||||
- Volume profile tick size:
|
||||
- Session:
|
||||
@@ -0,0 +1,23 @@
|
||||
## Description
|
||||
|
||||
Brief description of changes:
|
||||
|
||||
## Type of Change
|
||||
|
||||
- [ ] Bug fix
|
||||
- [ ] New feature
|
||||
- [ ] New instrument config
|
||||
- [ ] Dashboard improvement
|
||||
- [ ] Performance optimization
|
||||
- [ ] Documentation update
|
||||
|
||||
## Testing
|
||||
|
||||
- [ ] Tests pass (`pytest orderflow_system/test_integration.py`)
|
||||
- [ ] Tested with MT5 feed
|
||||
- [ ] Tested with Bybit feed
|
||||
- [ ] Tested in demo mode
|
||||
|
||||
## Related Issues
|
||||
|
||||
Fixes #
|
||||
@@ -0,0 +1,47 @@
|
||||
# Contributing to OrderFlow Analysis Pro
|
||||
|
||||
Thank you for your interest in contributing!
|
||||
|
||||
## Getting Started
|
||||
|
||||
1. Fork the repository
|
||||
2. Create a feature branch (`git checkout -b feature/my-feature`)
|
||||
3. Make your changes
|
||||
4. Run tests: `pytest orderflow_system/test_integration.py`
|
||||
5. Submit a pull request
|
||||
|
||||
## Development Setup
|
||||
|
||||
```bash
|
||||
pip install -e ".[dev]"
|
||||
```
|
||||
|
||||
## Areas for Contribution
|
||||
|
||||
- **New pattern detectors** — add to `patterns/` directory
|
||||
- **Additional instruments** — add config in `config/settings.py`
|
||||
- **Dashboard improvements** — frontend or API enhancements
|
||||
- **Documentation** — guides, tutorials, API docs
|
||||
- **Bug fixes** — check GitHub Issues
|
||||
|
||||
## Code Style
|
||||
|
||||
- Python 3.10+ with type hints
|
||||
- Dataclasses for data models
|
||||
- Async/await for I/O operations
|
||||
- Follow existing patterns in each module
|
||||
|
||||
## Reporting Issues
|
||||
|
||||
Use GitHub Issues to report:
|
||||
- Bugs or unexpected behavior
|
||||
- Feature requests
|
||||
- Documentation errors
|
||||
- Instrument configuration issues
|
||||
|
||||
## Pull Request Process
|
||||
|
||||
1. Ensure tests pass
|
||||
2. Add tests for new features
|
||||
3. Update documentation if needed
|
||||
4. Keep PRs focused — one feature or fix per PR
|
||||
@@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2025 Mahmoud
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
Reference in New Issue
Block a user