mt5cli 0.7.2__tar.gz → 0.8.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- mt5cli-0.8.0/.agents/skills/pr-feedback-triage/SKILL.md +149 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/.github/workflows/ci.yml +15 -0
- mt5cli-0.8.0/AGENTS.md +37 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/PKG-INFO +32 -1
- {mt5cli-0.7.2 → mt5cli-0.8.0}/README.md +31 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/docs/api/history.md +29 -3
- {mt5cli-0.7.2 → mt5cli-0.8.0}/docs/api/sdk.md +20 -5
- mt5cli-0.8.0/docs/api/trading.md +114 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/mt5cli/__init__.py +42 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/mt5cli/history.py +72 -10
- {mt5cli-0.7.2 → mt5cli-0.8.0}/mt5cli/sdk.py +29 -14
- mt5cli-0.8.0/mt5cli/trading.py +861 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/mt5cli/utils.py +14 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/pyproject.toml +1 -1
- {mt5cli-0.7.2 → mt5cli-0.8.0}/tests/test_history.py +36 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/tests/test_sdk.py +60 -3
- mt5cli-0.8.0/tests/test_trading.py +1270 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/uv.lock +1 -1
- mt5cli-0.7.2/AGENTS.md +0 -81
- mt5cli-0.7.2/docs/api/trading.md +0 -70
- mt5cli-0.7.2/mt5cli/trading.py +0 -210
- mt5cli-0.7.2/tests/test_trading.py +0 -356
- {mt5cli-0.7.2 → mt5cli-0.8.0}/.agents/skills/local-qa/SKILL.md +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/.agents/skills/local-qa/scripts/qa.sh +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/.agents/skills/mt5cli/SKILL.md +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/.claude/agents/codex.md +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/.claude/settings.json +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/.github/FUNDING.yml +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/.github/dependabot.yml +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/.github/renovate.json +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/.github/workflows/claude.yml +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/.github/workflows/release.yml +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/.gitignore +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/CLAUDE.md +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/LICENSE +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/docs/api/cli.md +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/docs/api/client.md +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/docs/api/converters.md +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/docs/api/exceptions.md +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/docs/api/index.md +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/docs/api/schemas.md +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/docs/api/storage.md +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/docs/api/utils.md +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/docs/index.md +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/mkdocs.yml +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/mt5cli/__main__.py +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/mt5cli/cli.py +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/mt5cli/client.py +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/mt5cli/converters.py +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/mt5cli/exceptions.py +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/mt5cli/retry.py +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/mt5cli/schemas.py +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/mt5cli/storage.py +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/tests/__init__.py +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/tests/conftest.py +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/tests/test_cli.py +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/tests/test_contracts.py +0 -0
- {mt5cli-0.7.2 → mt5cli-0.8.0}/tests/test_utils.py +0 -0
|
@@ -0,0 +1,149 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: pr-feedback-triage
|
|
3
|
+
description: Triage pull request review comments into fixes, replies, clarification requests, or open follow-ups while respecting safe execution modes.
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
# PR Feedback Triage
|
|
7
|
+
|
|
8
|
+
Triage pull request review feedback, decide what action each thread needs, make focused fixes when allowed, and report or resolve only what is actually handled.
|
|
9
|
+
|
|
10
|
+
## When to Use
|
|
11
|
+
|
|
12
|
+
- A PR has review comments, requested changes, unresolved review threads, or bot review findings.
|
|
13
|
+
- The user asks to address, respond to, or resolve PR feedback.
|
|
14
|
+
- The user provides a PR URL/number, a branch with an associated PR, or copied comments.
|
|
15
|
+
|
|
16
|
+
Do not use this skill for a first-pass code review with no existing feedback; use a code review skill instead.
|
|
17
|
+
|
|
18
|
+
## Inputs
|
|
19
|
+
|
|
20
|
+
- Pull request URL or number, or a current branch that has an associated pull request.
|
|
21
|
+
- Repository checkout or platform access sufficient to inspect the PR diff and review feedback.
|
|
22
|
+
- Optional reviewer priorities from the user, such as "only address blocking comments" or "do not reply on the PR platform".
|
|
23
|
+
- Optional operating mode flags: `dry_run`, `no_push`, and `no_reply`.
|
|
24
|
+
|
|
25
|
+
If no PR or review comments are identifiable, ask for the target PR or the copied comments before proceeding.
|
|
26
|
+
|
|
27
|
+
## Modes
|
|
28
|
+
|
|
29
|
+
- `dry_run`: inspect review feedback and report the triage only. Do not edit files, run write-mode formatters, commit, push, post replies, or resolve review threads.
|
|
30
|
+
- `no_push`: local edits and verification are allowed, but do not push commits or otherwise update the remote branch. Report the local diff or local commits that still need to be pushed.
|
|
31
|
+
- `no_reply`: do not post replies, submit reviews, or resolve review threads. Provide suggested replies and resolution actions in the final report instead.
|
|
32
|
+
|
|
33
|
+
When a mode disables an action, skip that destructive or externally visible action even if normal workflow text would otherwise allow it.
|
|
34
|
+
|
|
35
|
+
## Preflight
|
|
36
|
+
|
|
37
|
+
1. Identify the current branch and target PR.
|
|
38
|
+
2. Check tracked local changes with `git diff --name-only` and `git diff --cached --name-only`. Ignore untracked files unless the review feedback explicitly concerns them.
|
|
39
|
+
3. Check unpushed commits before relying on remote review feedback.
|
|
40
|
+
4. If tracked local changes or unpushed commits exist, warn that existing PR comments may not cover the latest local state. In `normal` mode, push only when the user request or repository workflow allows it; otherwise continue with a clearly reported limitation.
|
|
41
|
+
|
|
42
|
+
## Feedback Collection
|
|
43
|
+
|
|
44
|
+
Gather the complete feedback set before editing:
|
|
45
|
+
|
|
46
|
+
- Fetch unresolved review threads, requested-change reviews, PR-level summary comments, and copied comments.
|
|
47
|
+
- Use platform-native APIs/CLI when available. Paginate results; do not inspect only the first page of threads or comments.
|
|
48
|
+
- For bot reviewers that post both summary comments and inline comments, collect both. Summary comments often contain severity, rationale, and fix instructions; inline comments contain the exact file and line context.
|
|
49
|
+
- Preserve each thread/comment identifier needed to reply or resolve later.
|
|
50
|
+
- Compare each comment with the current diff and file contents because review lines can become outdated.
|
|
51
|
+
|
|
52
|
+
## Deduplication and Ordering
|
|
53
|
+
|
|
54
|
+
Build one triage record per distinct finding:
|
|
55
|
+
|
|
56
|
+
- Prefer exact review-thread identity when available.
|
|
57
|
+
- For duplicate bot findings appearing in both summary and inline comments, merge by exact issue title first, then by file path plus line range as a fallback.
|
|
58
|
+
- Prefer inline comments for location and current code context.
|
|
59
|
+
- Prefer summary comments for severity, category, rationale, and detailed agent prompts.
|
|
60
|
+
- Preserve the reviewer’s exact issue title and original wording where practical. Do not rename findings in a way that would make replies hard to map back to comments.
|
|
61
|
+
- Preserve the reviewer’s original ordering unless the user asks for priority reordering. Many review bots already order findings by severity.
|
|
62
|
+
|
|
63
|
+
Each triage record should track: original title, reviewer, source IDs, location, current applicability, severity/priority if available, disposition, planned action, verification, reply text if any, and resolution decision.
|
|
64
|
+
|
|
65
|
+
## Resolution Policy
|
|
66
|
+
|
|
67
|
+
In normal mode, `Resolve conversation` is the default action for any review thread that has been fully handled. A thread is handled when the requested change is implemented and verified, the current code already satisfies the comment, the comment is outdated and no longer applies, or a deliberate deferral/won't-fix response has been posted with a clear reason.
|
|
68
|
+
|
|
69
|
+
Keep a thread open only when it still needs reviewer, maintainer, or product input, the fix is local-only and not pushed, verification is missing for a material change, or the user explicitly requested `dry_run`, `no_push`, or `no_reply` behavior that prevents resolution.
|
|
70
|
+
|
|
71
|
+
When resolving a thread, add a concise reply first only if it provides useful context, such as what changed, why no code change was needed, why a finding was intentionally deferred, or why the original comment is now outdated. Do not add noisy replies for self-evident fixes unless project norms require them.
|
|
72
|
+
|
|
73
|
+
## Flow
|
|
74
|
+
|
|
75
|
+
```mermaid
|
|
76
|
+
flowchart TD
|
|
77
|
+
A[Identify PR and branch state] --> B[Collect all review feedback]
|
|
78
|
+
B --> C[Deduplicate and preserve source IDs]
|
|
79
|
+
C --> D[Inspect current diff and code]
|
|
80
|
+
D --> E{Classify each triage record}
|
|
81
|
+
E -->|Fix| F[Implement minimal change]
|
|
82
|
+
E -->|Answer| G[Prepare concise reply]
|
|
83
|
+
E -->|Clarify| H[Leave open with question]
|
|
84
|
+
E -->|Already addressed or Outdated| I[Prepare evidence]
|
|
85
|
+
E -->|Defer or Won't fix| J[Document reason]
|
|
86
|
+
F --> K[Verify]
|
|
87
|
+
G --> L{Mode}
|
|
88
|
+
H --> L
|
|
89
|
+
I --> L
|
|
90
|
+
J --> L
|
|
91
|
+
K --> L
|
|
92
|
+
L -->|dry_run| M[Report triage only]
|
|
93
|
+
L -->|no_push| N[Report local diff or commits]
|
|
94
|
+
L -->|no_reply| O[Report suggested replies/actions]
|
|
95
|
+
L -->|normal| P[Commit/push if changed, then batch reply and resolve handled threads]
|
|
96
|
+
M --> Q[Final summary]
|
|
97
|
+
N --> Q
|
|
98
|
+
O --> Q
|
|
99
|
+
P --> Q
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
## Compact Workflow
|
|
103
|
+
|
|
104
|
+
1. **Collect all relevant feedback**
|
|
105
|
+
- Identify the PR and gather unresolved review threads, requested-change reviews, PR-level summaries, inline comments, and copied comments.
|
|
106
|
+
- Paginate all platform calls and keep comment/thread IDs for later replies and resolution.
|
|
107
|
+
- For bot reviews, collect both summary and inline comments, then merge duplicates rather than fixing the same finding twice.
|
|
108
|
+
|
|
109
|
+
2. **Classify each triage record**
|
|
110
|
+
- **Fix**: Valid requested change; make the smallest focused edit when not in `dry_run`.
|
|
111
|
+
- **Answer**: No code change needed; prepare a concise explanation.
|
|
112
|
+
- **Clarify**: Ambiguous, conflicting, or missing context; leave open with a question.
|
|
113
|
+
- **Already addressed**: Current code already satisfies it; prepare evidence.
|
|
114
|
+
- **Outdated**: Commented code or issue no longer exists; prepare evidence.
|
|
115
|
+
- **Defer / Won't fix**: Valid concern intentionally not changed now; document a specific reason.
|
|
116
|
+
|
|
117
|
+
3. **Act according to the classification and mode**
|
|
118
|
+
- Keep edits scoped to the review feedback.
|
|
119
|
+
- Follow reviewer-provided fix instructions literally when they are still applicable; deviate only when the current code proves the instruction is stale or unsafe.
|
|
120
|
+
- In `dry_run`, stop at triage, proposed fixes, suggested replies, and verification plan.
|
|
121
|
+
- In `no_push`, local edits are allowed, but do not push or resolve threads for local-only fixes.
|
|
122
|
+
- In `no_reply`, do not post replies or resolve threads; report suggested replies/actions instead.
|
|
123
|
+
- In normal mode, batch replies where practical, then resolve every handled thread by default after the fix, explanation, or deferral reason is available on the PR.
|
|
124
|
+
|
|
125
|
+
4. **Verify before claiming completion**
|
|
126
|
+
- For fixes, run appropriate checks or explain why they could not run.
|
|
127
|
+
- Re-inspect the updated diff and comment context to confirm the concern is resolved.
|
|
128
|
+
- Do not mark a thread resolved if it still needs reviewer, maintainer, or product input.
|
|
129
|
+
|
|
130
|
+
5. **Finish**
|
|
131
|
+
- Normal mode: commit/push changes when appropriate, post useful replies or a summary, and resolve all handled threads by default.
|
|
132
|
+
- Safe modes: report the local state and the exact replies/resolution actions a human could take.
|
|
133
|
+
|
|
134
|
+
## Reply Guidance
|
|
135
|
+
|
|
136
|
+
- Keep inline replies short and tied to the original title or concern.
|
|
137
|
+
- For fixed findings, mention the concrete change or commit if useful.
|
|
138
|
+
- For already-addressed or outdated findings, cite the current code path or behavior that makes the finding no longer applicable.
|
|
139
|
+
- For deferred or won't-fix findings, provide the reason and any follow-up issue or owner if known.
|
|
140
|
+
- If a reply or resolve operation fails, continue with the remaining threads and report the failure in the final summary.
|
|
141
|
+
|
|
142
|
+
## Final Summary Checklist
|
|
143
|
+
|
|
144
|
+
- Mode used: `normal`, `dry_run`, `no_push`, or `no_reply`
|
|
145
|
+
- Counts by disposition: fixed, answered, clarified/left open, already addressed, outdated, deferred/won't-fix
|
|
146
|
+
- Threads resolved, intentionally left open, or resolution actions skipped by mode
|
|
147
|
+
- Verification run or planned
|
|
148
|
+
- Commits pushed, local diff/commits, or "none"
|
|
149
|
+
- Remaining open items and who needs to respond
|
|
@@ -62,6 +62,19 @@ jobs:
|
|
|
62
62
|
runs-on: ubuntu-slim
|
|
63
63
|
secrets:
|
|
64
64
|
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
65
|
+
github-codeql-analysis:
|
|
66
|
+
if: >
|
|
67
|
+
github.event_name == 'push'
|
|
68
|
+
|| github.event_name == 'pull_request'
|
|
69
|
+
|| (github.event_name == 'workflow_dispatch' && inputs.workflow == 'lint-and-test')
|
|
70
|
+
permissions:
|
|
71
|
+
contents: read
|
|
72
|
+
security-events: write
|
|
73
|
+
actions: read
|
|
74
|
+
uses: dceoy/gh-actions-for-devops/.github/workflows/github-codeql-analysis.yml@main # zizmor: ignore[unpinned-uses]
|
|
75
|
+
with:
|
|
76
|
+
language: >
|
|
77
|
+
["python"]
|
|
65
78
|
dependabot-auto-merge:
|
|
66
79
|
if: >
|
|
67
80
|
github.event_name == 'pull_request' && github.actor == 'dependabot[bot]'
|
|
@@ -73,5 +86,7 @@ jobs:
|
|
|
73
86
|
contents: write
|
|
74
87
|
pull-requests: write
|
|
75
88
|
actions: read
|
|
89
|
+
checks: read
|
|
90
|
+
statuses: read
|
|
76
91
|
with:
|
|
77
92
|
unconditional: true
|
mt5cli-0.8.0/AGENTS.md
ADDED
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
# Repository Guidelines
|
|
2
|
+
|
|
3
|
+
## Project Structure & Module Organization
|
|
4
|
+
|
|
5
|
+
`mt5cli/` contains the package source. Important modules include `cli.py` for the Typer command-line app, `client.py` and `sdk.py` for public MT5 client/session APIs, `history.py` for SQLite history collection, `storage.py` and `converters.py` for export behavior, and `schemas.py` for normalized dataset contracts. `tests/` holds pytest coverage for CLI behavior, SDK contracts, trading helpers, history, and utilities. `docs/` and `mkdocs.yml` define the MkDocs site and API reference. `skills/mt5cli/SKILL.md` documents the mt5cli agent skill.
|
|
6
|
+
|
|
7
|
+
## Build, Test, and Development Commands
|
|
8
|
+
|
|
9
|
+
- `uv sync` installs runtime and development dependencies from `pyproject.toml` and `uv.lock`.
|
|
10
|
+
- `uv run mt5cli --help` runs the local CLI entry point.
|
|
11
|
+
- `uv run ruff format .` formats Python files.
|
|
12
|
+
- `uv run ruff check --fix .` lints and applies safe fixes.
|
|
13
|
+
- `uv run pyright .` runs strict type checking.
|
|
14
|
+
- `uv run pytest` runs doctests, branch coverage, and the test suite.
|
|
15
|
+
- `uv run mkdocs serve` previews documentation locally; `uv run mkdocs build` validates the docs build.
|
|
16
|
+
|
|
17
|
+
Use `.agents/skills/local-qa/SKILL.md` for pre-handoff QA. It runs `.agents/skills/local-qa/scripts/qa.sh`, which formats, lints, type-checks, tests, formats Markdown, and checks GitHub workflows.
|
|
18
|
+
|
|
19
|
+
## Coding Style & Naming Conventions
|
|
20
|
+
|
|
21
|
+
Target Python `>=3.11,<3.14`. Use Ruff’s configured 88-character line length and Google-style docstrings. Pyright is strict, so prefer explicit public type annotations and narrow exception handling. Keep module, function, and variable names in `snake_case`; classes and enums use `PascalCase`. Preserve the package’s small, typed helper style rather than adding broad abstractions.
|
|
22
|
+
|
|
23
|
+
## Design Principles
|
|
24
|
+
|
|
25
|
+
Apply KISS, DRY, and YAGNI when changing code. Prefer the simplest implementation that satisfies the current CLI/API contract. Remove duplication when shared behavior is already proven by at least two concrete call sites, but avoid generic helpers for speculative reuse. Do not add configuration flags, extension hooks, or alternate backends until a real repository use case requires them.
|
|
26
|
+
|
|
27
|
+
## Testing Guidelines
|
|
28
|
+
|
|
29
|
+
Tests use pytest, pytest-mock, doctests, and pytest-cov. Test files should match `tests/test_*.py`, classes `Test*`, and functions `test_*`. Coverage is configured with `fail_under = 100`, so add focused tests for every behavior change. Mock MT5/pdmt5 boundaries; do not require a live MetaTrader terminal in unit tests.
|
|
30
|
+
|
|
31
|
+
## Commit & Pull Request Guidelines
|
|
32
|
+
|
|
33
|
+
Recent history uses concise imperative commits, sometimes with conventional prefixes such as `feat:` or `chore:` and PR numbers appended by GitHub. Keep commits scoped to one logical change. Pull requests should describe behavior changes, note tests run, link related issues, and call out MT5/live-trading risk where relevant.
|
|
34
|
+
|
|
35
|
+
## Security & Configuration Tips
|
|
36
|
+
|
|
37
|
+
Never commit account credentials, broker passwords, exported private data, or local `.venv` contents. Treat `order_send` and CLI `order-send --yes` as live execution paths; gate examples and tests so they cannot place real trades accidentally.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: mt5cli
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.8.0
|
|
4
4
|
Summary: Generic MT5 data and execution infrastructure for Python applications
|
|
5
5
|
Project-URL: Repository, https://github.com/dceoy/mt5cli.git
|
|
6
6
|
Author-email: dceoy <dceoy@users.noreply.github.com>
|
|
@@ -109,6 +109,37 @@ Schema contracts live in `mt5cli.schemas` (`DataKind`, `validate_schema`, `norma
|
|
|
109
109
|
|
|
110
110
|
`MT5Client.order_send()` is a live execution primitive: it can place real trades on the connected account. mt5cli does not implement strategy logic, signal generation, backtesting, or optimization — downstream applications must gate live execution explicitly.
|
|
111
111
|
|
|
112
|
+
### Trading lifecycle and state helpers
|
|
113
|
+
|
|
114
|
+
Trading applications can depend on `mt5cli` imports only; terminal path,
|
|
115
|
+
credentials, server, and timeout are forwarded to `pdmt5.Mt5Config`, numeric
|
|
116
|
+
login strings are coerced to integers, and empty login strings are treated as
|
|
117
|
+
unset.
|
|
118
|
+
|
|
119
|
+
```python
|
|
120
|
+
from mt5cli import (
|
|
121
|
+
calculate_spread_ratio,
|
|
122
|
+
create_trading_client,
|
|
123
|
+
get_account_snapshot,
|
|
124
|
+
mt5_trading_session,
|
|
125
|
+
)
|
|
126
|
+
|
|
127
|
+
with mt5_trading_session(
|
|
128
|
+
path=r"C:\Program Files\MetaTrader 5\terminal64.exe",
|
|
129
|
+
login="12345",
|
|
130
|
+
password="from-env-or-secret-store",
|
|
131
|
+
server="Broker-Demo",
|
|
132
|
+
) as client:
|
|
133
|
+
account = get_account_snapshot(client)
|
|
134
|
+
spread = calculate_spread_ratio(client, "EURUSD")
|
|
135
|
+
|
|
136
|
+
client = create_trading_client(login=12345, server="Broker-Demo")
|
|
137
|
+
try:
|
|
138
|
+
positions = client.positions_get_as_df(symbol="EURUSD")
|
|
139
|
+
finally:
|
|
140
|
+
client.shutdown()
|
|
141
|
+
```
|
|
142
|
+
|
|
112
143
|
## CLI usage
|
|
113
144
|
|
|
114
145
|
```bash
|
|
@@ -85,6 +85,37 @@ Schema contracts live in `mt5cli.schemas` (`DataKind`, `validate_schema`, `norma
|
|
|
85
85
|
|
|
86
86
|
`MT5Client.order_send()` is a live execution primitive: it can place real trades on the connected account. mt5cli does not implement strategy logic, signal generation, backtesting, or optimization — downstream applications must gate live execution explicitly.
|
|
87
87
|
|
|
88
|
+
### Trading lifecycle and state helpers
|
|
89
|
+
|
|
90
|
+
Trading applications can depend on `mt5cli` imports only; terminal path,
|
|
91
|
+
credentials, server, and timeout are forwarded to `pdmt5.Mt5Config`, numeric
|
|
92
|
+
login strings are coerced to integers, and empty login strings are treated as
|
|
93
|
+
unset.
|
|
94
|
+
|
|
95
|
+
```python
|
|
96
|
+
from mt5cli import (
|
|
97
|
+
calculate_spread_ratio,
|
|
98
|
+
create_trading_client,
|
|
99
|
+
get_account_snapshot,
|
|
100
|
+
mt5_trading_session,
|
|
101
|
+
)
|
|
102
|
+
|
|
103
|
+
with mt5_trading_session(
|
|
104
|
+
path=r"C:\Program Files\MetaTrader 5\terminal64.exe",
|
|
105
|
+
login="12345",
|
|
106
|
+
password="from-env-or-secret-store",
|
|
107
|
+
server="Broker-Demo",
|
|
108
|
+
) as client:
|
|
109
|
+
account = get_account_snapshot(client)
|
|
110
|
+
spread = calculate_spread_ratio(client, "EURUSD")
|
|
111
|
+
|
|
112
|
+
client = create_trading_client(login=12345, server="Broker-Demo")
|
|
113
|
+
try:
|
|
114
|
+
positions = client.positions_get_as_df(symbol="EURUSD")
|
|
115
|
+
finally:
|
|
116
|
+
client.shutdown()
|
|
117
|
+
```
|
|
118
|
+
|
|
88
119
|
## CLI usage
|
|
89
120
|
|
|
90
121
|
```bash
|
|
@@ -167,19 +167,45 @@ Resolution rules:
|
|
|
167
167
|
|
|
168
168
|
### Rate data loading
|
|
169
169
|
|
|
170
|
-
|
|
171
|
-
`
|
|
170
|
+
The canonical normalized rate table is `rates`; compatibility views are named
|
|
171
|
+
with `rate_<symbol>__<timeframe>` for single-timeframe symbols or
|
|
172
|
+
`rate_<symbol>__<granularity>_<timeframe>` when a symbol has multiple stored
|
|
173
|
+
timeframes. `resolve_rate_table_name()` returns `rates`, while
|
|
174
|
+
`resolve_rate_view_name()` returns the per-symbol compatibility view name.
|
|
175
|
+
|
|
176
|
+
Use `load_rate_data()` or `load_rate_series_from_sqlite(..., table=...)` to load
|
|
177
|
+
a single table or view from a SQLite path. Use
|
|
178
|
+
`load_rate_series_by_granularity()` to load multiple instrument/granularity
|
|
179
|
+
targets without hard-coding view names:
|
|
172
180
|
|
|
173
181
|
```python
|
|
174
182
|
from pathlib import Path
|
|
175
183
|
|
|
176
|
-
from mt5cli import
|
|
184
|
+
from mt5cli import (
|
|
185
|
+
load_rate_data,
|
|
186
|
+
load_rate_series_by_granularity,
|
|
187
|
+
load_rate_series_from_sqlite,
|
|
188
|
+
resolve_rate_table_name,
|
|
189
|
+
)
|
|
177
190
|
from mt5cli.history import resolve_rate_view_name
|
|
178
191
|
|
|
179
192
|
view = resolve_rate_view_name(Path("history.db"), "EURUSD", "M1", require_existing=True)
|
|
180
193
|
rates = load_rate_data(Path("history.db"), view, count=1000)
|
|
194
|
+
same_rates = load_rate_series_from_sqlite(Path("history.db"), table=view, count=1000)
|
|
195
|
+
|
|
196
|
+
table = resolve_rate_table_name("EURUSD", "M1") # "rates"
|
|
197
|
+
series = load_rate_series_by_granularity(
|
|
198
|
+
Path("history.db"),
|
|
199
|
+
symbols=["EURUSD", "GBPUSD"],
|
|
200
|
+
granularities=["M1", "H1"],
|
|
201
|
+
count=500,
|
|
202
|
+
)
|
|
181
203
|
```
|
|
182
204
|
|
|
205
|
+
`count` returns the latest rows while preserving chronological order. Missing
|
|
206
|
+
tables/views and mismatched `explicit_tables` lengths raise `ValueError` with
|
|
207
|
+
the requested database target in the message.
|
|
208
|
+
|
|
183
209
|
The loader accepts close-based OHLC rate data or tick-like bid/ask data. It
|
|
184
210
|
validates that `time` exists, parses timestamps with pandas, and returns a
|
|
185
211
|
DataFrame indexed by ascending `DatetimeIndex` named `time`.
|
|
@@ -31,13 +31,25 @@ rates = collect_latest_rates_for_accounts_with_retries(
|
|
|
31
31
|
### Latest closed rate bars
|
|
32
32
|
|
|
33
33
|
MetaTrader 5 `start_pos=0` includes the still-forming current bar as the last
|
|
34
|
-
row. `
|
|
35
|
-
|
|
36
|
-
non-empty.
|
|
37
|
-
|
|
34
|
+
row. `fetch_latest_closed_rates()` handles one connected client; multi-account
|
|
35
|
+
helpers fetch `count + 1` bars, drop that row with `drop_forming_rate_bar()`,
|
|
36
|
+
and validate each series is non-empty. Returned frames are ordered
|
|
37
|
+
oldest-to-newest and may contain fewer than `count` rows only when MT5 returns
|
|
38
|
+
fewer closed bars.
|
|
38
39
|
|
|
39
40
|
```python
|
|
40
|
-
from mt5cli import
|
|
41
|
+
from mt5cli import (
|
|
42
|
+
AccountSpec,
|
|
43
|
+
collect_latest_closed_rates_by_granularity,
|
|
44
|
+
fetch_latest_closed_rates,
|
|
45
|
+
)
|
|
46
|
+
|
|
47
|
+
closed = fetch_latest_closed_rates(
|
|
48
|
+
client,
|
|
49
|
+
symbol="EURUSD",
|
|
50
|
+
granularity="M1",
|
|
51
|
+
count=500,
|
|
52
|
+
)
|
|
41
53
|
|
|
42
54
|
rates = collect_latest_closed_rates_by_granularity(
|
|
43
55
|
[AccountSpec(symbols=["EURUSD"], login=12345)],
|
|
@@ -48,6 +60,9 @@ rates = collect_latest_closed_rates_by_granularity(
|
|
|
48
60
|
closed_m1 = rates["EURUSD", "M1"]
|
|
49
61
|
```
|
|
50
62
|
|
|
63
|
+
Use `collect_latest_closed_rates_by_granularity()` when callers prefer keys such
|
|
64
|
+
as `("EURUSD", "M1")` instead of integer timeframes.
|
|
65
|
+
|
|
51
66
|
### Resolving credentials and `${ENV_VAR}` placeholders
|
|
52
67
|
|
|
53
68
|
`resolve_account_spec()` / `resolve_account_specs()` merge explicit override
|
|
@@ -0,0 +1,114 @@
|
|
|
1
|
+
# Trading Module
|
|
2
|
+
|
|
3
|
+
::: mt5cli.trading
|
|
4
|
+
|
|
5
|
+
## Trading-capable MT5 sessions
|
|
6
|
+
|
|
7
|
+
`create_trading_client()` and `mt5_trading_session()` complement the read-only
|
|
8
|
+
`mt5_session()` helper in `sdk.py`. They return or yield an initialized
|
|
9
|
+
`pdmt5.Mt5TradingClient`, use `Mt5Config.path` to launch the terminal when
|
|
10
|
+
configured, and `mt5_trading_session()` always calls `shutdown()` on exit.
|
|
11
|
+
|
|
12
|
+
```python
|
|
13
|
+
from mt5cli import create_trading_client, mt5_trading_session
|
|
14
|
+
|
|
15
|
+
with mt5_trading_session(
|
|
16
|
+
path=r"C:\Program Files\MetaTrader 5\terminal64.exe",
|
|
17
|
+
login="12345",
|
|
18
|
+
password="secret",
|
|
19
|
+
server="Broker-Demo",
|
|
20
|
+
retry_count=2,
|
|
21
|
+
) as client:
|
|
22
|
+
positions = client.positions_get_as_df(symbol="EURUSD")
|
|
23
|
+
|
|
24
|
+
client = create_trading_client(login=12345, server="Broker-Demo")
|
|
25
|
+
try:
|
|
26
|
+
account = client.account_info_as_dict()
|
|
27
|
+
finally:
|
|
28
|
+
client.shutdown()
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
`login` accepts `int`, numeric `str`, or an empty string; empty strings are
|
|
32
|
+
treated as unset. `path`, `password`, `server`, and `timeout` are forwarded to
|
|
33
|
+
`pdmt5.Mt5Config`, and omitted `timeout` values keep the lower-level default.
|
|
34
|
+
The read-only `Mt5CliClient` / `mt5_session()` API is unchanged.
|
|
35
|
+
|
|
36
|
+
## State and order helpers
|
|
37
|
+
|
|
38
|
+
These helpers are strategy-agnostic and do not depend on signal detection,
|
|
39
|
+
betting logic, or scheduling code in downstream applications.
|
|
40
|
+
|
|
41
|
+
```python
|
|
42
|
+
from mt5cli import (
|
|
43
|
+
calculate_spread_ratio,
|
|
44
|
+
calculate_margin_and_volume,
|
|
45
|
+
close_open_positions,
|
|
46
|
+
detect_position_side,
|
|
47
|
+
determine_order_limits,
|
|
48
|
+
get_account_snapshot,
|
|
49
|
+
get_positions_frame,
|
|
50
|
+
get_symbol_snapshot,
|
|
51
|
+
get_tick_snapshot,
|
|
52
|
+
place_market_order,
|
|
53
|
+
)
|
|
54
|
+
|
|
55
|
+
account = get_account_snapshot(client)
|
|
56
|
+
symbol = get_symbol_snapshot(client, "EURUSD")
|
|
57
|
+
tick = get_tick_snapshot(client, "EURUSD")
|
|
58
|
+
positions = get_positions_frame(client, "EURUSD")
|
|
59
|
+
side = detect_position_side(client, "EURUSD")
|
|
60
|
+
spread_ratio = calculate_spread_ratio(client, "EURUSD")
|
|
61
|
+
sizing = calculate_margin_and_volume(
|
|
62
|
+
client,
|
|
63
|
+
"EURUSD",
|
|
64
|
+
unit_margin_ratio=0.5,
|
|
65
|
+
preserved_margin_ratio=0.2,
|
|
66
|
+
)
|
|
67
|
+
limits = determine_order_limits(
|
|
68
|
+
client,
|
|
69
|
+
"EURUSD",
|
|
70
|
+
side="long",
|
|
71
|
+
stop_loss_limit_ratio=0.01,
|
|
72
|
+
take_profit_limit_ratio=0.02,
|
|
73
|
+
)
|
|
74
|
+
preview = place_market_order(
|
|
75
|
+
client,
|
|
76
|
+
symbol="EURUSD",
|
|
77
|
+
volume=sizing["buy_volume"],
|
|
78
|
+
order_side="BUY",
|
|
79
|
+
sl=limits["stop_loss"],
|
|
80
|
+
tp=limits["take_profit"],
|
|
81
|
+
dry_run=True,
|
|
82
|
+
)
|
|
83
|
+
closed = close_open_positions(client, symbols="EURUSD", dry_run=True)
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
`detect_position_side()` returns `long` for buy-only exposure, `short` for
|
|
87
|
+
sell-only exposure, and `None` for no positions or mixed long/short exposure.
|
|
88
|
+
`calculate_spread_ratio()` uses `(ask - bid) / ((ask + bid) / 2)` and raises
|
|
89
|
+
`Mt5TradingError` when bid or ask is missing or non-positive.
|
|
90
|
+
|
|
91
|
+
SL/TP ratios for `determine_order_limits()` must satisfy `0 <= ratio < 1`; `0`
|
|
92
|
+
omits that level. SL/TP prices are rounded with symbol `digits` metadata when
|
|
93
|
+
available. `unit_margin_ratio` and `preserved_margin_ratio` for
|
|
94
|
+
`calculate_margin_and_volume()` accept `0 <= ratio <= 1`; `unit_margin_ratio=0`
|
|
95
|
+
requests one minimum valid unit when the post-reserve margin can afford it.
|
|
96
|
+
Negative `margin_free` is clamped to `0.0` before sizing. Execution helpers
|
|
97
|
+
return normalized dictionaries containing the request, response, status,
|
|
98
|
+
retcode, and `dry_run` flag; `dry_run=True` never sends an order. Market order
|
|
99
|
+
helpers mark known non-success MT5 retcodes as `status="failed"` while keeping
|
|
100
|
+
the normalized response for inspection.
|
|
101
|
+
|
|
102
|
+
## Migration from mteor-local helpers
|
|
103
|
+
|
|
104
|
+
| mteor-local concern | mt5cli replacement |
|
|
105
|
+
| -------------------------------------------------------- | ----------------------------------------------- |
|
|
106
|
+
| Manual terminal spawn/kill around trading code | `mt5_trading_session()` |
|
|
107
|
+
| Local position-side detection | `detect_position_side()` |
|
|
108
|
+
| Local margin/volume sizing | `calculate_margin_and_volume()` |
|
|
109
|
+
| Local SL/TP price derivation | `determine_order_limits()` |
|
|
110
|
+
| Throttled SQLite history loop with ad-hoc error handling | `ThrottledHistoryUpdater(suppress_errors=True)` |
|
|
111
|
+
|
|
112
|
+
Keep read-only data collection on `mt5_session()` / `Mt5CliClient`; use
|
|
113
|
+
`mt5_trading_session()` only where order placement or trading calculations are
|
|
114
|
+
required.
|
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
from importlib.metadata import version
|
|
4
4
|
|
|
5
|
+
from pdmt5 import Mt5Config, Mt5RuntimeError, Mt5TradingClient, Mt5TradingError
|
|
6
|
+
|
|
5
7
|
from .client import MT5Client, build_config, mt5_session
|
|
6
8
|
from .converters import (
|
|
7
9
|
ensure_utc,
|
|
@@ -32,6 +34,7 @@ from .history import (
|
|
|
32
34
|
resolve_history_datasets,
|
|
33
35
|
resolve_history_tick_flags,
|
|
34
36
|
resolve_history_timeframes,
|
|
37
|
+
resolve_rate_table_name,
|
|
35
38
|
resolve_rate_tables,
|
|
36
39
|
resolve_rate_view_name,
|
|
37
40
|
resolve_rate_view_names,
|
|
@@ -63,6 +66,7 @@ from .sdk import (
|
|
|
63
66
|
copy_rates_range,
|
|
64
67
|
copy_ticks_from,
|
|
65
68
|
copy_ticks_range,
|
|
69
|
+
fetch_latest_closed_rates,
|
|
66
70
|
history_deals,
|
|
67
71
|
history_orders,
|
|
68
72
|
last_error,
|
|
@@ -96,10 +100,26 @@ from .storage import (
|
|
|
96
100
|
export_dataframe_to_sqlite,
|
|
97
101
|
)
|
|
98
102
|
from .trading import (
|
|
103
|
+
POSITION_COLUMNS,
|
|
104
|
+
OrderFillingMode,
|
|
105
|
+
OrderSide,
|
|
106
|
+
OrderTimeMode,
|
|
107
|
+
PositionSide,
|
|
99
108
|
calculate_margin_and_volume,
|
|
109
|
+
calculate_new_position_margin_ratio,
|
|
110
|
+
calculate_spread_ratio,
|
|
111
|
+
calculate_volume_by_margin,
|
|
112
|
+
close_open_positions,
|
|
113
|
+
create_trading_client,
|
|
100
114
|
detect_position_side,
|
|
101
115
|
determine_order_limits,
|
|
116
|
+
get_account_snapshot,
|
|
117
|
+
get_positions_frame,
|
|
118
|
+
get_symbol_snapshot,
|
|
119
|
+
get_tick_snapshot,
|
|
102
120
|
mt5_trading_session,
|
|
121
|
+
place_market_order,
|
|
122
|
+
update_sltp_for_open_positions,
|
|
103
123
|
)
|
|
104
124
|
from .utils import (
|
|
105
125
|
TICK_FLAG_MAP,
|
|
@@ -114,6 +134,7 @@ __version__ = version(__package__) if __package__ else None
|
|
|
114
134
|
__all__ = [
|
|
115
135
|
"DEDUP_KEYS",
|
|
116
136
|
"KNOWN_MT5_TIME_COLUMNS",
|
|
137
|
+
"POSITION_COLUMNS",
|
|
117
138
|
"REQUIRED_COLUMNS",
|
|
118
139
|
"TICK_FLAG_MAP",
|
|
119
140
|
"TIMEFRAME_MAP",
|
|
@@ -125,9 +146,17 @@ __all__ = [
|
|
|
125
146
|
"MT5Client",
|
|
126
147
|
"Mt5CliClient",
|
|
127
148
|
"Mt5CliError",
|
|
149
|
+
"Mt5Config",
|
|
128
150
|
"Mt5ConnectionError",
|
|
129
151
|
"Mt5OperationError",
|
|
152
|
+
"Mt5RuntimeError",
|
|
130
153
|
"Mt5SchemaError",
|
|
154
|
+
"Mt5TradingClient",
|
|
155
|
+
"Mt5TradingError",
|
|
156
|
+
"OrderFillingMode",
|
|
157
|
+
"OrderSide",
|
|
158
|
+
"OrderTimeMode",
|
|
159
|
+
"PositionSide",
|
|
131
160
|
"RateTarget",
|
|
132
161
|
"ThrottledHistoryUpdater",
|
|
133
162
|
"account_info",
|
|
@@ -135,7 +164,11 @@ __all__ = [
|
|
|
135
164
|
"build_rate_targets",
|
|
136
165
|
"build_rate_view_name",
|
|
137
166
|
"calculate_margin_and_volume",
|
|
167
|
+
"calculate_new_position_margin_ratio",
|
|
168
|
+
"calculate_spread_ratio",
|
|
169
|
+
"calculate_volume_by_margin",
|
|
138
170
|
"call_with_normalized_errors",
|
|
171
|
+
"close_open_positions",
|
|
139
172
|
"collect_history",
|
|
140
173
|
"collect_latest_closed_rates_by_granularity",
|
|
141
174
|
"collect_latest_closed_rates_for_accounts",
|
|
@@ -147,6 +180,7 @@ __all__ = [
|
|
|
147
180
|
"copy_rates_range",
|
|
148
181
|
"copy_ticks_from",
|
|
149
182
|
"copy_ticks_range",
|
|
183
|
+
"create_trading_client",
|
|
150
184
|
"detect_format",
|
|
151
185
|
"detect_position_side",
|
|
152
186
|
"determine_order_limits",
|
|
@@ -154,6 +188,11 @@ __all__ = [
|
|
|
154
188
|
"ensure_utc",
|
|
155
189
|
"export_dataframe",
|
|
156
190
|
"export_dataframe_to_sqlite",
|
|
191
|
+
"fetch_latest_closed_rates",
|
|
192
|
+
"get_account_snapshot",
|
|
193
|
+
"get_positions_frame",
|
|
194
|
+
"get_symbol_snapshot",
|
|
195
|
+
"get_tick_snapshot",
|
|
157
196
|
"granularity_name",
|
|
158
197
|
"history_deals",
|
|
159
198
|
"history_orders",
|
|
@@ -181,6 +220,7 @@ __all__ = [
|
|
|
181
220
|
"parse_datetime",
|
|
182
221
|
"parse_tick_flags",
|
|
183
222
|
"parse_timeframe",
|
|
223
|
+
"place_market_order",
|
|
184
224
|
"positions",
|
|
185
225
|
"recent_history_deals",
|
|
186
226
|
"recent_ticks",
|
|
@@ -190,6 +230,7 @@ __all__ = [
|
|
|
190
230
|
"resolve_history_datasets",
|
|
191
231
|
"resolve_history_tick_flags",
|
|
192
232
|
"resolve_history_timeframes",
|
|
233
|
+
"resolve_rate_table_name",
|
|
193
234
|
"resolve_rate_tables",
|
|
194
235
|
"resolve_rate_view_name",
|
|
195
236
|
"resolve_rate_view_names",
|
|
@@ -201,5 +242,6 @@ __all__ = [
|
|
|
201
242
|
"terminal_info",
|
|
202
243
|
"update_history",
|
|
203
244
|
"update_history_with_config",
|
|
245
|
+
"update_sltp_for_open_positions",
|
|
204
246
|
"validate_schema",
|
|
205
247
|
]
|