Skip to content

Commit b83d984

Browse files
raidos23raidos23
committed
Stabilise la CI et enrichit la documentation projet
Remplace la pipeline CI par une version plus réaliste, maintenable et alignée sur l'état actuel du dépôt. Le workflow est désormais structuré autour de trois étapes claires : lint, tests en matrice Ubuntu/Windows avec Python 3.12 et 3.13, puis smoke checks. Les références obsolètes de l'ancien workflow ont été retirées et les commandes smoke ont été réalignées sur les options CLI réellement disponibles dans l'application. Met à jour le README pour refléter les options CLI réelles exposées par PyCompiler ARK, notamment les variantes classic/IDE, les options de lancement et les commandes smoke utiles. Le README sert désormais mieux de point d'entrée rapide pour les usages courants ainsi que pour les nouveaux documents de référence ajoutés au dépôt. Ajoute une documentation détaillée du dependency analyzer, en explicitant son objectif, sa classification des imports, ses heuristiques principales, le filtrage des fichiers analysés, l'extraction testable des imports et les limites connues de l'approche heuristique. Cette documentation complète le durcissement technique déjà effectué sur l'analyseur. Ajoute une vue d'architecture synthétique du projet couvrant les couches Core, CLI, UI, Engine, BCASL et orchestration de compilation, ainsi qu'un guide contributeur directement exploitable décrivant l'installation, les vérifications locales, les zones de code à modifier et les attentes en matière de documentation et de maintenance. Ajoute une checklist de smoke release dédiée et met à jour TODO.md pour marquer comme réalisées les tâches liées à la stabilisation de la CI, à la checklist de release, à la documentation d'architecture, à la documentation du dependency analyzer, au guide de contribution et à la mise à jour du README.
1 parent 03b37b8 commit b83d984

7 files changed

Lines changed: 397 additions & 119 deletions

File tree

‎.github/workflows/ci.yml‎

Lines changed: 49 additions & 77 deletions
Original file line numberDiff line numberDiff line change
@@ -2,81 +2,41 @@ name: CI
22

33
on:
44
push:
5-
branches: [main, develop]
5+
branches: [main, develop, develop2]
66
pull_request:
7-
branches: [main, develop]
7+
branches: [main, develop, develop2]
88
workflow_dispatch:
99

1010
jobs:
1111
lint:
12-
name: Lint (ruff + black)
12+
name: Lint
1313
runs-on: ubuntu-latest
1414
steps:
1515
- name: Checkout repository
1616
uses: actions/checkout@v4
1717

18-
- name: Set up Python
18+
- name: Set up Python 3.12
1919
uses: actions/setup-python@v5
2020
with:
21-
python-version: "3.13"
22-
cache: "pip"
21+
python-version: "3.12"
22+
cache: pip
23+
cache-dependency-path: requirements.txt
2324

24-
- name: Install tooling
25-
run: |
26-
python -m pip install --upgrade pip
27-
pip install ruff black
25+
- name: Upgrade pip
26+
run: python -m pip install --upgrade pip
2827

29-
- name: Ruff (progressive scope)
30-
run: |
31-
ruff check \
32-
Core/deps_analyser/analyser.py \
33-
Core/IdeLikeGui/connections.py \
34-
EngineLoader/base.py \
35-
tests/test_engine_install_flow.py \
36-
tests/test_deps_analyser_heuristics.py
37-
38-
- name: Black (progressive scope)
39-
run: |
40-
black --check \
41-
Core/deps_analyser/analyser.py \
42-
Core/IdeLikeGui/connections.py \
43-
EngineLoader/base.py \
44-
tests/test_engine_install_flow.py \
45-
tests/test_deps_analyser_heuristics.py
46-
47-
typecheck:
48-
name: Type check (progressive scope)
49-
runs-on: ubuntu-latest
50-
steps:
51-
- name: Checkout repository
52-
uses: actions/checkout@v4
53-
54-
- name: Set up Python
55-
uses: actions/setup-python@v5
56-
with:
57-
python-version: "3.13"
58-
cache: "pip"
28+
- name: Install lint dependencies
29+
run: python -m pip install -r requirements.txt
5930

60-
- name: Install typing tool
61-
run: |
62-
python -m pip install --upgrade pip
63-
pip install mypy
31+
- name: Ruff
32+
run: ruff check .
6433

65-
- name: Mypy (progressive scope)
66-
run: |
67-
mypy \
68-
--ignore-missing-imports \
69-
--follow-imports skip \
70-
--disable-error-code attr-defined \
71-
--disable-error-code import-untyped \
72-
EngineLoader/base.py \
73-
Core/deps_analyser/analyser.py \
74-
Core/IdeLikeGui/connections.py \
75-
tests/test_engine_install_flow.py \
76-
tests/test_deps_analyser_heuristics.py
34+
- name: Black
35+
run: black --check .
7736

7837
tests:
7938
name: Tests (${{ matrix.os }}, py${{ matrix.python-version }})
39+
needs: lint
8040
runs-on: ${{ matrix.os }}
8141
strategy:
8242
fail-fast: false
@@ -89,51 +49,63 @@ jobs:
8949
- name: Checkout repository
9050
uses: actions/checkout@v4
9151

92-
- name: Set up Python
52+
- name: Set up Python ${{ matrix.python-version }}
9353
uses: actions/setup-python@v5
9454
with:
9555
python-version: ${{ matrix.python-version }}
96-
cache: "pip"
56+
cache: pip
57+
cache-dependency-path: requirements.txt
9758

9859
- name: Install dependencies
9960
run: |
10061
python -m pip install --upgrade pip
10162
pip install -r requirements.txt
10263
103-
- name: Run unit tests
104-
run: pytest -q
64+
- name: Install test dependencies
65+
run: python -m pip install -r requirements.txt
66+
67+
- name: Run pytest
68+
run: python -m pytest -q tests
10569

10670
smoke:
107-
name: Smoke checks (${{ matrix.os }})
71+
name: Smoke (${{ matrix.os }}, py${{ matrix.python-version }})
72+
needs: tests
10873
runs-on: ${{ matrix.os }}
109-
needs: [lint, typecheck, tests]
11074
strategy:
11175
fail-fast: false
11276
matrix:
11377
os: [ubuntu-latest, windows-latest]
78+
python-version: ["3.12", "3.13"]
11479
env:
11580
QT_QPA_PLATFORM: offscreen
11681
steps:
11782
- name: Checkout repository
11883
uses: actions/checkout@v4
11984

120-
- name: Set up Python
85+
- name: Set up Python ${{ matrix.python-version }}
12186
uses: actions/setup-python@v5
12287
with:
123-
python-version: "3.13"
124-
cache: "pip"
88+
python-version: ${{ matrix.python-version }}
89+
cache: pip
90+
cache-dependency-path: requirements.txt
12591

126-
- name: Install dependencies
127-
run: |
128-
python -m pip install --upgrade pip
129-
pip install -r requirements.txt
92+
- name: Upgrade pip
93+
run: python -m pip install --upgrade pip
13094

131-
- name: Compile sources
132-
run: python -m compileall -q .
95+
- name: Install runtime dependencies
96+
run: python -m pip install -r requirements.txt
13397

134-
- name: CLI smoke
135-
run: |
136-
python pycompiler_ark.py --help
137-
python pycompiler_ark.py --help-all
138-
python pycompiler_ark.py --version
139-
python pycompiler_ark.py --info
98+
- name: Smoke CLI help
99+
run: python -m pycompiler_ark --help
100+
101+
- name: Smoke version
102+
run: python -m pycompiler_ark --version
103+
104+
- name: Smoke system info
105+
run: python -m pycompiler_ark --info
106+
107+
- name: Smoke engines dry-run
108+
run: python -m pycompiler_ark engines --dry-run
109+
110+
- name: Smoke source compilation
111+
run: python -m py_compile pycompiler_ark.py

‎README.md‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,10 @@ python pycompiler_ark.py --info
8484
python pycompiler_ark.py --cli
8585
python pycompiler_ark.py --ide-gui
8686
python pycompiler_ark.py --classic-gui
87+
python pycompiler_ark.py --no-splash
8788
python pycompiler_ark.py --unload
89+
python pycompiler_ark.py bcasl
90+
python pycompiler_ark.py engines --dry-run
8891
```
8992

9093
### Dedicated CLI quick commands
@@ -127,17 +130,15 @@ python -m OnlyMod.EngineOnlyMod --engine nuitka -f script.py --dry-run
127130

128131
## Documentation
129132

133+
- [Architecture overview](docs/architecture.md)
134+
- [Contributing guide](docs/contributing.md)
135+
- [Dependency analyzer](docs/dependency_analyzer.md)
130136
- [How to create an engine](docs/how_to_create_an_engine.md)
131137
- [How to create a BC plugin](docs/how_to_create_a_bc_plugin.md)
132138
- [Dedicated interactive CLI (`--cli`)](docs/dedicated_cli.md)
133139
- [IDE-like main GUI (`--ide-gui`)](docs/ide_like_gui.md)
140+
- [IDE/classic parity matrix](docs/ide_classic_parity.md)
134141
- [Release smoke checklist](docs/release_smoke_checklist.md)
135-
- [IDE GUI parity matrix](docs/ide_gui_parity_matrix.md)
136-
- [Versioning and release flow](docs/versioning_and_release.md)
137-
- [Dependency analyzer details](docs/deps_analyzer.md)
138-
- [Architecture overview](docs/architecture_overview.md)
139-
- [Quality freeze and blockers](docs/quality_freeze_and_blockers.md)
140-
- [Contributing guide](CONTRIBUTING.md)
141142

142143
---
143144

@@ -171,8 +172,8 @@ python -m OnlyMod.EngineOnlyMod --engine nuitka -f script.py --dry-run
171172
```bash
172173
ruff check .
173174
black --check .
174-
mypy .
175-
pytest
175+
pytest -q tests
176+
python -m py_compile pycompiler_ark.py
176177
```
177178

178179
---

‎TODO.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,3 +68,12 @@
6868

6969
- [x] finaliser la parite IDE/classic et documenter la matrice de parite.
7070
- [x] durcir l'analyseur deps avec un parseur d'imports testable et une meilleure couverture des imports relatifs et dynamiques.
71+
- [x] stabiliser la CI avec une matrix Ubuntu/Windows en Python 3.12/3.13, puis des smoke checks realistes.
72+
- [x] ajouter une checklist de smoke release dediee.
73+
74+
## Phase 7
75+
76+
- [x] mettre a jour le README avec les options CLI reelles et les nouveaux liens de documentation.
77+
- [x] ajouter une documentation detaillee du dependency analyzer.
78+
- [x] ajouter une vue d'architecture Core/Engine/UI.
79+
- [x] ajouter un guide contributeur operable.

‎docs/architecture.md‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
# Architecture Overview
2+
3+
This document provides a high-level map of the main runtime layers in PyCompiler ARK.
4+
5+
## Core layers
6+
7+
### 1. Bootstrap and CLI
8+
9+
Main entrypoints:
10+
11+
- `pycompiler_ark.py`
12+
- `cli/entrypoint.py`
13+
- `cli/click_app.py`
14+
- `cli/fallback.py`
15+
- `cli/dedicated.py`
16+
17+
Responsibilities:
18+
19+
- parse top-level CLI options
20+
- choose between Click-based CLI and fallback mode
21+
- launch the main GUI, BCASL standalone, or Engines standalone
22+
- expose the dedicated interactive CLI
23+
24+
### 2. Main GUI and UI wiring
25+
26+
Main files:
27+
28+
- `Core/Gui.py`
29+
- `Core/UiConnection.py`
30+
- `Core/UiFeatures.py`
31+
- `Core/IdeLikeGui/connections.py`
32+
- `ui/ui_design.ui`
33+
- `ui/ui_ide_design2.ui`
34+
35+
Responsibilities:
36+
37+
- create the main application window
38+
- map Qt widgets to Python attributes
39+
- connect UI actions to shared application logic
40+
- support both classic and IDE-like layouts
41+
- apply theme and translation behavior
42+
43+
### 3. Workspace and environment management
44+
45+
Main files:
46+
47+
- `Core/WorkSpaceManager/`
48+
- `Core/Venv_Manager/Manager.py`
49+
- `Core/ArkConfigManager.py`
50+
51+
Responsibilities:
52+
53+
- manage workspace selection and file discovery
54+
- detect and create virtual environments
55+
- install requirements and tool dependencies
56+
- load and persist workspace-oriented configuration
57+
58+
### 4. Compilation orchestration
59+
60+
Main files:
61+
62+
- `Core/Compiler/`
63+
- `EngineLoader/`
64+
- `ENGINES/`
65+
- `engine_sdk/`
66+
67+
Responsibilities:
68+
69+
- run preflight checks
70+
- load engines dynamically
71+
- build compile commands
72+
- execute compilation processes
73+
- report logs, progress, and statistics
74+
75+
### 5. BCASL pre-compilation pipeline
76+
77+
Main files:
78+
79+
- `bcasl/`
80+
- `Plugins/`
81+
- `Plugins_SDK/`
82+
- `OnlyMod/BcaslOnlyMod/`
83+
84+
Responsibilities:
85+
86+
- validate plugin compatibility
87+
- discover and order BCASL plugins
88+
- run pre-compilation tasks before build execution
89+
- expose standalone BCASL tooling
90+
91+
## Dependency flow
92+
93+
At a high level:
94+
95+
1. CLI or GUI selects a workspace and files.
96+
2. BCASL may run first if configured.
97+
3. The selected engine resolves its required tools.
98+
4. System dependencies are checked before Python tool installation.
99+
5. The engine builds the final compile command.
100+
6. `Core.Compiler` executes and monitors the process.
101+
102+
## UI variants
103+
104+
There are two main UI variants:
105+
106+
- classic GUI
107+
- IDE-like GUI
108+
109+
Shared behavior should stay in reusable helpers when possible. The IDE-like UI should extend the classic behavior rather than fork it. See [IDE/classic parity matrix](./ide_classic_parity.md).
110+
111+
## Design guideline
112+
113+
When changing behavior:
114+
115+
- prefer shared core logic over UI-specific duplication
116+
- keep engine-specific behavior inside engines or engine SDK helpers
117+
- keep UI wiring thin and declarative
118+
- add tests when introducing new heuristics or CLI behavior

0 commit comments

Comments
 (0)