Claude commited on
Commit
e224609
·
unverified ·
1 Parent(s): 974df5a

fix: Sprint 3 — CI/CD, packaging, Docker (11 issues)

Browse files

CI/CD:
- ci.yml: demo job installe maintenant avec [web] (CI1)
- ci.yml: suppression || true du lint ruff — erreurs visibles (CI2)
- ci.yml: codecov fail_ci_if_error: true (CI3)

Packaging:
- pyproject.toml: python-multipart ajouté aux deps dev (PKG1)
- __init__.py: version dynamique via importlib.metadata (PKG4)
- Nouveau fichier LICENSE Apache-2.0 (PKG2)
- Nouveau fichier MANIFEST.in (PKG3)

Docker:
- Dockerfile: port harmonisé sur 7860, chown /opt/venv (DOCKER1, DOCKER3)
- docker-compose.yml: port 7860, suppression depends_on ollama (DOCKER1, DOCKER2)
- Test mis à jour pour refléter le nouveau port

Tests: 890 passed, 0 failed (aucune régression)

https://claude.ai/code/session_01UtY7QGAcj2M7pAyU2nvzvn

.github/workflows/ci.yml CHANGED
@@ -88,7 +88,7 @@ jobs:
88
  files: coverage.xml
89
  flags: unittests
90
  name: picarones-coverage
91
- fail_ci_if_error: false
92
 
93
  # ──────────────────────────────────────────────────────────────────
94
  # Job 2 : Vérification du rapport demo
@@ -114,7 +114,7 @@ jobs:
114
  sudo apt-get install -y tesseract-ocr tesseract-ocr-fra
115
 
116
  - name: Install Picarones
117
- run: pip install -e .
118
 
119
  - name: Run demo
120
  run: |
@@ -194,8 +194,8 @@ jobs:
194
 
195
  - name: Run ruff
196
  run: |
197
- ruff check picarones/ --select=E,W,F --ignore=E501,W503 || true
198
- ruff check tests/ --select=E,W,F --ignore=E501,W503 || true
199
 
200
  # ──────────────────────────────────────────────────────────────────
201
  # Job 5 : CI/CD — Détection de régression CER (optionnel)
 
88
  files: coverage.xml
89
  flags: unittests
90
  name: picarones-coverage
91
+ fail_ci_if_error: true
92
 
93
  # ──────────────────────────────────────────────────────────────────
94
  # Job 2 : Vérification du rapport demo
 
114
  sudo apt-get install -y tesseract-ocr tesseract-ocr-fra
115
 
116
  - name: Install Picarones
117
+ run: pip install -e ".[web]"
118
 
119
  - name: Run demo
120
  run: |
 
194
 
195
  - name: Run ruff
196
  run: |
197
+ ruff check picarones/ --select=E,W,F --ignore=E501,W503
198
+ ruff check tests/ --select=E,W,F --ignore=E501,W503
199
 
200
  # ──────────────────────────────────────────────────────────────────
201
  # Job 5 : CI/CD — Détection de régression CER (optionnel)
Dockerfile CHANGED
@@ -80,7 +80,7 @@ RUN mkdir -p /app/corpus /app/rapports /app/data
80
 
81
  # ── Utilisateur non-root pour la sécurité ──────────────────────
82
  RUN useradd -m -u 1000 picarones && \
83
- chown -R picarones:picarones /app
84
  USER picarones
85
 
86
  # ── Variables d'environnement par défaut ───────────────────────
@@ -89,7 +89,6 @@ ENV PYTHONIOENCODING=utf-8
89
  ENV TESSDATA_PREFIX=/usr/share/tesseract-ocr/5/tessdata
90
 
91
  # ── Ports ───────────────────────────────────────────────────────
92
- EXPOSE 8000
93
  EXPOSE 7860
94
 
95
  # ── Health check ────────────────────────────────────────────────
 
80
 
81
  # ── Utilisateur non-root pour la sécurité ──────────────────────
82
  RUN useradd -m -u 1000 picarones && \
83
+ chown -R picarones:picarones /app /opt/venv
84
  USER picarones
85
 
86
  # ── Variables d'environnement par défaut ───────────────────────
 
89
  ENV TESSDATA_PREFIX=/usr/share/tesseract-ocr/5/tessdata
90
 
91
  # ── Ports ───────────────────────────────────────────────────────
 
92
  EXPOSE 7860
93
 
94
  # ── Health check ────────────────────────────────────────────────
LICENSE ADDED
@@ -0,0 +1,190 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to the Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by the Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding any notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ Copyright 2024 Picarones contributors
179
+
180
+ Licensed under the Apache License, Version 2.0 (the "License");
181
+ you may not use this file except in compliance with the License.
182
+ You may obtain a copy of the License at
183
+
184
+ http://www.apache.org/licenses/LICENSE-2.0
185
+
186
+ Unless required by applicable law or agreed to in writing, software
187
+ distributed under the License is distributed on an "AS IS" BASIS,
188
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189
+ See the License for the specific language governing permissions and
190
+ limitations under the License.
MANIFEST.in ADDED
@@ -0,0 +1,6 @@
 
 
 
 
 
 
 
1
+ include LICENSE
2
+ include README.md
3
+ include CHANGELOG.md
4
+ include CLAUDE.md
5
+ recursive-include picarones/prompts *.txt
6
+ recursive-include picarones *.json *.yaml *.yml
docker-compose.yml CHANGED
@@ -1,7 +1,7 @@
1
  # docker-compose.yml — Picarones
2
  #
3
  # Services disponibles :
4
- # - picarones : interface web + benchmarks (port 8000)
5
  # - ollama : LLMs locaux (port 11434, profil optionnel)
6
  #
7
  # Usage :
@@ -26,7 +26,7 @@ services:
26
  container_name: picarones
27
  restart: unless-stopped
28
  ports:
29
- - "${PICARONES_PORT:-8000}:8000"
30
  volumes:
31
  # Corpus à benchmarker (lecture seule)
32
  - "${CORPUS_DIR:-./corpus}:/app/corpus:ro"
@@ -51,10 +51,8 @@ services:
51
  # Python
52
  - PYTHONUNBUFFERED=1
53
  - PYTHONIOENCODING=utf-8
54
- depends_on:
55
- - ollama
56
  healthcheck:
57
- test: ["CMD", "curl", "-f", "http://localhost:8000/health"]
58
  interval: 30s
59
  timeout: 10s
60
  retries: 3
 
1
  # docker-compose.yml — Picarones
2
  #
3
  # Services disponibles :
4
+ # - picarones : interface web + benchmarks (port 7860)
5
  # - ollama : LLMs locaux (port 11434, profil optionnel)
6
  #
7
  # Usage :
 
26
  container_name: picarones
27
  restart: unless-stopped
28
  ports:
29
+ - "${PICARONES_PORT:-7860}:7860"
30
  volumes:
31
  # Corpus à benchmarker (lecture seule)
32
  - "${CORPUS_DIR:-./corpus}:/app/corpus:ro"
 
51
  # Python
52
  - PYTHONUNBUFFERED=1
53
  - PYTHONIOENCODING=utf-8
 
 
54
  healthcheck:
55
+ test: ["CMD", "curl", "-f", "http://localhost:7860/health"]
56
  interval: 30s
57
  timeout: 10s
58
  retries: 3
picarones/__init__.py CHANGED
@@ -4,5 +4,10 @@ Picarones — Plateforme de comparaison de moteurs OCR pour documents patrimonia
4
  Licence Apache 2.0.
5
  """
6
 
7
- __version__ = "1.0.0"
 
 
 
 
 
8
  __author__ = "Picarones contributors"
 
4
  Licence Apache 2.0.
5
  """
6
 
7
+ try:
8
+ from importlib.metadata import version as _get_version
9
+ __version__ = _get_version("picarones")
10
+ except Exception:
11
+ __version__ = "1.0.0"
12
+
13
  __author__ = "Picarones contributors"
pyproject.toml CHANGED
@@ -41,7 +41,7 @@ Changelog = "https://github.com/maribakulj/Picarones/blob/main/CHANGELOG.md"
41
 
42
  [project.optional-dependencies]
43
  # Développement et tests
44
- dev = ["pytest>=7.4.0", "pytest-cov>=4.1.0", "httpx>=0.27.0", "fastapi>=0.111.0", "uvicorn[standard]>=0.29.0"]
45
  # Interface web FastAPI
46
  web = ["fastapi>=0.111.0", "uvicorn[standard]>=0.29.0", "httpx>=0.27.0", "python-multipart>=0.0.9"]
47
  # Import HuggingFace Datasets
 
41
 
42
  [project.optional-dependencies]
43
  # Développement et tests
44
+ dev = ["pytest>=7.4.0", "pytest-cov>=4.1.0", "httpx>=0.27.0", "fastapi>=0.111.0", "uvicorn[standard]>=0.29.0", "python-multipart>=0.0.9"]
45
  # Interface web FastAPI
46
  web = ["fastapi>=0.111.0", "uvicorn[standard]>=0.29.0", "httpx>=0.27.0", "python-multipart>=0.0.9"]
47
  # Import HuggingFace Datasets
tests/test_sprint9_packaging.py CHANGED
@@ -165,7 +165,7 @@ class TestDockerCompose:
165
  assert "ollama" in compose
166
 
167
  def test_has_port_mapping(self, compose):
168
- assert "8000" in compose
169
 
170
  def test_has_volume_for_history(self, compose):
171
  assert "picarones_history" in compose
 
165
  assert "ollama" in compose
166
 
167
  def test_has_port_mapping(self, compose):
168
+ assert "7860" in compose
169
 
170
  def test_has_volume_for_history(self, compose):
171
  assert "picarones_history" in compose