nmk-python 0.15.1__py3-none-any.whl → 0.16.0__py3-none-any.whl

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.
nmk_python/build.py CHANGED
@@ -5,12 +5,11 @@ Python package build module
5
5
  import shutil
6
6
  import sys
7
7
  from pathlib import Path
8
- from typing import Dict, List
9
8
 
10
9
  from nmk.model.builder import NmkTaskBuilder
11
10
  from nmk.model.keys import NmkRootConfig
12
11
  from nmk.model.resolver import NmkStrConfigResolver
13
- from nmk.utils import is_windows, run_with_logs
12
+ from nmk.utils import is_windows, run_pip, run_with_logs
14
13
  from nmk_base.venvbuilder import VenvUpdateBuilder
15
14
  from tomlkit import loads
16
15
  from tomlkit.toml_file import TOMLFile
@@ -21,7 +20,7 @@ class PackageBuilder(NmkTaskBuilder):
21
20
  Python package builder
22
21
  """
23
22
 
24
- def build(self, project_file: str, version_file: str, source_dirs: List[str], artifacts_dir: str, build_dir: str, extra_resources: Dict[str, str]):
23
+ def build(self, project_file: str, version_file: str, source_dirs: list[str], artifacts_dir: str, build_dir: str, extra_resources: dict[str, str]):
25
24
  """
26
25
  Delegate to python build module, from a temporary build folder
27
26
 
@@ -125,3 +124,21 @@ class Installer(VenvUpdateBuilder):
125
124
  self.logger.warning("Can't install nmk while running nmk!")
126
125
  else:
127
126
  super().build(pip_args)
127
+
128
+
129
+ class Uninstaller(NmkTaskBuilder):
130
+ """
131
+ Uninstall current project wheel from venv
132
+ """
133
+
134
+ def build(self, name: str):
135
+ """
136
+ Uninstall wheel from venv
137
+
138
+ Note that task won't fail if the wheel is not installed
139
+
140
+ :param name: wheel name to be uninstalled
141
+ """
142
+
143
+ # Simply delegate to pip
144
+ run_pip(["uninstall", "--yes", name], logger=self.logger)
nmk_python/build.yml CHANGED
@@ -92,3 +92,14 @@ tasks:
92
92
  pip_args: --force-reinstall --no-deps ${venvPipArgs}
93
93
  # - force reinstall because otherwise install will be skipped if version didn't changed
94
94
  # - but skip dependencies to avoid reinstalling everything (deps are already installed by py.venv task)
95
+
96
+ # Python module clean
97
+ py.uninstall:
98
+ description: Uninstall python package
99
+ emoji: ":broom:.:snake:"
100
+ appendToDeps:
101
+ - clean
102
+ builder: nmk_python.build.Uninstaller
103
+ params:
104
+ name: ${pythonPackage}
105
+ if: ${pythonSrcFiles} # Only if python source files are found
nmk_python/files.py CHANGED
@@ -3,7 +3,6 @@ Python files resolvers
3
3
  """
4
4
 
5
5
  from pathlib import Path
6
- from typing import List
7
6
 
8
7
  from nmk.model.resolver import NmkListConfigResolver
9
8
 
@@ -13,7 +12,7 @@ class FilesFinder(NmkListConfigResolver):
13
12
  Shared logic for files resolution
14
13
  """
15
14
 
16
- def find_in_folders(self) -> List[str]: # pragma: no cover
15
+ def find_in_folders(self) -> list[str]: # pragma: no cover
17
16
  """
18
17
  Folders to be browsed (to be overridden)
19
18
 
@@ -21,7 +20,7 @@ class FilesFinder(NmkListConfigResolver):
21
20
  """
22
21
  pass
23
22
 
24
- def get_value(self, name: str) -> List[Path]:
23
+ def get_value(self, name: str) -> list[Path]:
25
24
  """
26
25
  Browse for source files in specified folders
27
26
 
@@ -35,13 +34,13 @@ class FilesFinder(NmkListConfigResolver):
35
34
  class PythonFilesFinder(FilesFinder):
36
35
  """Regular python files resolver"""
37
36
 
38
- def find_in_folders(self) -> List[str]:
37
+ def find_in_folders(self) -> list[str]:
39
38
  """
40
39
  Python source folders
41
40
  """
42
41
  return self.model.config["pythonSrcFolders"].value
43
42
 
44
- def get_value(self, name: str) -> List[Path]:
43
+ def get_value(self, name: str) -> list[Path]:
45
44
  """
46
45
  Browse for python files in specified folders
47
46
 
@@ -60,7 +59,7 @@ class PythonFilesFinder(FilesFinder):
60
59
  class PythonTestFilesFinder(FilesFinder):
61
60
  """Test python files resolver"""
62
61
 
63
- def find_in_folders(self) -> List[str]:
62
+ def find_in_folders(self) -> list[str]:
64
63
  """
65
64
  Python tests source folders
66
65
  """
nmk_python/project.yml CHANGED
@@ -25,7 +25,8 @@ tasks:
25
25
  - py.version
26
26
  appendToDeps: setup
27
27
  if: ${pythonSrcFiles} # Only if python source files are found
28
- builder: nmk_python.project.PythonProjectBuilder
28
+ builder: nmk_base.common.TomlFileBuilder
29
29
  params:
30
30
  fragment_files: ${pythonProjectFileFragments}
31
31
  items: ${pythonProjectFileItems}
32
+ plugin_name: nmk-python
nmk_python/ruff.py CHANGED
@@ -4,7 +4,6 @@ Ruff tool handling
4
4
 
5
5
  import contextlib
6
6
  from pathlib import Path
7
- from typing import List
8
7
 
9
8
  from nmk.model.builder import NmkTaskBuilder
10
9
  from nmk.model.keys import NmkRootConfig
@@ -16,7 +15,7 @@ class RuffBuilder(NmkTaskBuilder):
16
15
  Ruff tool builder
17
16
  """
18
17
 
19
- def build(self, src_folders: List[str], command: str):
18
+ def build(self, src_folders: list[str], command: str):
20
19
  """
21
20
  Invoke ruff
22
21
 
nmk_python/tests.py CHANGED
@@ -5,7 +5,6 @@ Python tests builder
5
5
  import shutil
6
6
  import subprocess
7
7
  import sys
8
- from typing import Dict
9
8
 
10
9
  from nmk.model.builder import NmkTaskBuilder
11
10
  from nmk.model.keys import NmkRootConfig
@@ -16,7 +15,7 @@ class PytestBuilder(NmkTaskBuilder):
16
15
  Python tests builder
17
16
  """
18
17
 
19
- def build(self, pytest_args: Dict[str, str]):
18
+ def build(self, pytest_args: dict[str, str]):
20
19
  """
21
20
  Invoke pytest with specified options
22
21
 
nmk_python/version.py CHANGED
@@ -4,7 +4,6 @@ Python version handling
4
4
 
5
5
  import platform
6
6
  import re
7
- from typing import List
8
7
 
9
8
  from nmk.model.builder import NmkTaskBuilder
10
9
  from nmk.model.resolver import NmkListConfigResolver, NmkStrConfigResolver
@@ -59,14 +58,14 @@ class PythonSupportedVersionsResolver(NmkListConfigResolver):
59
58
  Supported python versions range resolver
60
59
  """
61
60
 
62
- def get_value(self, name: str) -> List[str]:
61
+ def get_value(self, name: str) -> list[str]:
63
62
  """
64
63
  Returns supported python versions range
65
64
 
66
65
  :return: list of all python versions between min and max supported versions
67
66
  """
68
67
 
69
- def _split_version(v: str) -> List[int]:
68
+ def _split_version(v: str) -> list[int]:
70
69
  return list(map(int, v.split(".")))
71
70
 
72
71
  # Get min/max values, and verify consistency
@@ -0,0 +1,436 @@
1
+ Metadata-Version: 2.1
2
+ Name: nmk-python
3
+ Version: 0.16.0
4
+ Summary: Python plugin for nmk build system
5
+ Author: The dynod project
6
+ Maintainer: The dynod project
7
+ License: Mozilla Public License Version 2.0
8
+ ==================================
9
+
10
+ 1. Definitions
11
+ --------------
12
+
13
+ 1.1. "Contributor"
14
+ means each individual or legal entity that creates, contributes to
15
+ the creation of, or owns Covered Software.
16
+
17
+ 1.2. "Contributor Version"
18
+ means the combination of the Contributions of others (if any) used
19
+ by a Contributor and that particular Contributor's Contribution.
20
+
21
+ 1.3. "Contribution"
22
+ means Covered Software of a particular Contributor.
23
+
24
+ 1.4. "Covered Software"
25
+ means Source Code Form to which the initial Contributor has attached
26
+ the notice in Exhibit A, the Executable Form of such Source Code
27
+ Form, and Modifications of such Source Code Form, in each case
28
+ including portions thereof.
29
+
30
+ 1.5. "Incompatible With Secondary Licenses"
31
+ means
32
+
33
+ (a) that the initial Contributor has attached the notice described
34
+ in Exhibit B to the Covered Software; or
35
+
36
+ (b) that the Covered Software was made available under the terms of
37
+ version 1.1 or earlier of the License, but not also under the
38
+ terms of a Secondary License.
39
+
40
+ 1.6. "Executable Form"
41
+ means any form of the work other than Source Code Form.
42
+
43
+ 1.7. "Larger Work"
44
+ means a work that combines Covered Software with other material, in
45
+ a separate file or files, that is not Covered Software.
46
+
47
+ 1.8. "License"
48
+ means this document.
49
+
50
+ 1.9. "Licensable"
51
+ means having the right to grant, to the maximum extent possible,
52
+ whether at the time of the initial grant or subsequently, any and
53
+ all of the rights conveyed by this License.
54
+
55
+ 1.10. "Modifications"
56
+ means any of the following:
57
+
58
+ (a) any file in Source Code Form that results from an addition to,
59
+ deletion from, or modification of the contents of Covered
60
+ Software; or
61
+
62
+ (b) any new file in Source Code Form that contains any Covered
63
+ Software.
64
+
65
+ 1.11. "Patent Claims" of a Contributor
66
+ means any patent claim(s), including without limitation, method,
67
+ process, and apparatus claims, in any patent Licensable by such
68
+ Contributor that would be infringed, but for the grant of the
69
+ License, by the making, using, selling, offering for sale, having
70
+ made, import, or transfer of either its Contributions or its
71
+ Contributor Version.
72
+
73
+ 1.12. "Secondary License"
74
+ means either the GNU General Public License, Version 2.0, the GNU
75
+ Lesser General Public License, Version 2.1, the GNU Affero General
76
+ Public License, Version 3.0, or any later versions of those
77
+ licenses.
78
+
79
+ 1.13. "Source Code Form"
80
+ means the form of the work preferred for making modifications.
81
+
82
+ 1.14. "You" (or "Your")
83
+ means an individual or a legal entity exercising rights under this
84
+ License. For legal entities, "You" includes any entity that
85
+ controls, is controlled by, or is under common control with You. For
86
+ purposes of this definition, "control" means (a) the power, direct
87
+ or indirect, to cause the direction or management of such entity,
88
+ whether by contract or otherwise, or (b) ownership of more than
89
+ fifty percent (50%) of the outstanding shares or beneficial
90
+ ownership of such entity.
91
+
92
+ 2. License Grants and Conditions
93
+ --------------------------------
94
+
95
+ 2.1. Grants
96
+
97
+ Each Contributor hereby grants You a world-wide, royalty-free,
98
+ non-exclusive license:
99
+
100
+ (a) under intellectual property rights (other than patent or trademark)
101
+ Licensable by such Contributor to use, reproduce, make available,
102
+ modify, display, perform, distribute, and otherwise exploit its
103
+ Contributions, either on an unmodified basis, with Modifications, or
104
+ as part of a Larger Work; and
105
+
106
+ (b) under Patent Claims of such Contributor to make, use, sell, offer
107
+ for sale, have made, import, and otherwise transfer either its
108
+ Contributions or its Contributor Version.
109
+
110
+ 2.2. Effective Date
111
+
112
+ The licenses granted in Section 2.1 with respect to any Contribution
113
+ become effective for each Contribution on the date the Contributor first
114
+ distributes such Contribution.
115
+
116
+ 2.3. Limitations on Grant Scope
117
+
118
+ The licenses granted in this Section 2 are the only rights granted under
119
+ this License. No additional rights or licenses will be implied from the
120
+ distribution or licensing of Covered Software under this License.
121
+ Notwithstanding Section 2.1(b) above, no patent license is granted by a
122
+ Contributor:
123
+
124
+ (a) for any code that a Contributor has removed from Covered Software;
125
+ or
126
+
127
+ (b) for infringements caused by: (i) Your and any other third party's
128
+ modifications of Covered Software, or (ii) the combination of its
129
+ Contributions with other software (except as part of its Contributor
130
+ Version); or
131
+
132
+ (c) under Patent Claims infringed by Covered Software in the absence of
133
+ its Contributions.
134
+
135
+ This License does not grant any rights in the trademarks, service marks,
136
+ or logos of any Contributor (except as may be necessary to comply with
137
+ the notice requirements in Section 3.4).
138
+
139
+ 2.4. Subsequent Licenses
140
+
141
+ No Contributor makes additional grants as a result of Your choice to
142
+ distribute the Covered Software under a subsequent version of this
143
+ License (see Section 10.2) or under the terms of a Secondary License (if
144
+ permitted under the terms of Section 3.3).
145
+
146
+ 2.5. Representation
147
+
148
+ Each Contributor represents that the Contributor believes its
149
+ Contributions are its original creation(s) or it has sufficient rights
150
+ to grant the rights to its Contributions conveyed by this License.
151
+
152
+ 2.6. Fair Use
153
+
154
+ This License is not intended to limit any rights You have under
155
+ applicable copyright doctrines of fair use, fair dealing, or other
156
+ equivalents.
157
+
158
+ 2.7. Conditions
159
+
160
+ Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
161
+ in Section 2.1.
162
+
163
+ 3. Responsibilities
164
+ -------------------
165
+
166
+ 3.1. Distribution of Source Form
167
+
168
+ All distribution of Covered Software in Source Code Form, including any
169
+ Modifications that You create or to which You contribute, must be under
170
+ the terms of this License. You must inform recipients that the Source
171
+ Code Form of the Covered Software is governed by the terms of this
172
+ License, and how they can obtain a copy of this License. You may not
173
+ attempt to alter or restrict the recipients' rights in the Source Code
174
+ Form.
175
+
176
+ 3.2. Distribution of Executable Form
177
+
178
+ If You distribute Covered Software in Executable Form then:
179
+
180
+ (a) such Covered Software must also be made available in Source Code
181
+ Form, as described in Section 3.1, and You must inform recipients of
182
+ the Executable Form how they can obtain a copy of such Source Code
183
+ Form by reasonable means in a timely manner, at a charge no more
184
+ than the cost of distribution to the recipient; and
185
+
186
+ (b) You may distribute such Executable Form under the terms of this
187
+ License, or sublicense it under different terms, provided that the
188
+ license for the Executable Form does not attempt to limit or alter
189
+ the recipients' rights in the Source Code Form under this License.
190
+
191
+ 3.3. Distribution of a Larger Work
192
+
193
+ You may create and distribute a Larger Work under terms of Your choice,
194
+ provided that You also comply with the requirements of this License for
195
+ the Covered Software. If the Larger Work is a combination of Covered
196
+ Software with a work governed by one or more Secondary Licenses, and the
197
+ Covered Software is not Incompatible With Secondary Licenses, this
198
+ License permits You to additionally distribute such Covered Software
199
+ under the terms of such Secondary License(s), so that the recipient of
200
+ the Larger Work may, at their option, further distribute the Covered
201
+ Software under the terms of either this License or such Secondary
202
+ License(s).
203
+
204
+ 3.4. Notices
205
+
206
+ You may not remove or alter the substance of any license notices
207
+ (including copyright notices, patent notices, disclaimers of warranty,
208
+ or limitations of liability) contained within the Source Code Form of
209
+ the Covered Software, except that You may alter any license notices to
210
+ the extent required to remedy known factual inaccuracies.
211
+
212
+ 3.5. Application of Additional Terms
213
+
214
+ You may choose to offer, and to charge a fee for, warranty, support,
215
+ indemnity or liability obligations to one or more recipients of Covered
216
+ Software. However, You may do so only on Your own behalf, and not on
217
+ behalf of any Contributor. You must make it absolutely clear that any
218
+ such warranty, support, indemnity, or liability obligation is offered by
219
+ You alone, and You hereby agree to indemnify every Contributor for any
220
+ liability incurred by such Contributor as a result of warranty, support,
221
+ indemnity or liability terms You offer. You may include additional
222
+ disclaimers of warranty and limitations of liability specific to any
223
+ jurisdiction.
224
+
225
+ 4. Inability to Comply Due to Statute or Regulation
226
+ ---------------------------------------------------
227
+
228
+ If it is impossible for You to comply with any of the terms of this
229
+ License with respect to some or all of the Covered Software due to
230
+ statute, judicial order, or regulation then You must: (a) comply with
231
+ the terms of this License to the maximum extent possible; and (b)
232
+ describe the limitations and the code they affect. Such description must
233
+ be placed in a text file included with all distributions of the Covered
234
+ Software under this License. Except to the extent prohibited by statute
235
+ or regulation, such description must be sufficiently detailed for a
236
+ recipient of ordinary skill to be able to understand it.
237
+
238
+ 5. Termination
239
+ --------------
240
+
241
+ 5.1. The rights granted under this License will terminate automatically
242
+ if You fail to comply with any of its terms. However, if You become
243
+ compliant, then the rights granted under this License from a particular
244
+ Contributor are reinstated (a) provisionally, unless and until such
245
+ Contributor explicitly and finally terminates Your grants, and (b) on an
246
+ ongoing basis, if such Contributor fails to notify You of the
247
+ non-compliance by some reasonable means prior to 60 days after You have
248
+ come back into compliance. Moreover, Your grants from a particular
249
+ Contributor are reinstated on an ongoing basis if such Contributor
250
+ notifies You of the non-compliance by some reasonable means, this is the
251
+ first time You have received notice of non-compliance with this License
252
+ from such Contributor, and You become compliant prior to 30 days after
253
+ Your receipt of the notice.
254
+
255
+ 5.2. If You initiate litigation against any entity by asserting a patent
256
+ infringement claim (excluding declaratory judgment actions,
257
+ counter-claims, and cross-claims) alleging that a Contributor Version
258
+ directly or indirectly infringes any patent, then the rights granted to
259
+ You by any and all Contributors for the Covered Software under Section
260
+ 2.1 of this License shall terminate.
261
+
262
+ 5.3. In the event of termination under Sections 5.1 or 5.2 above, all
263
+ end user license agreements (excluding distributors and resellers) which
264
+ have been validly granted by You or Your distributors under this License
265
+ prior to termination shall survive termination.
266
+
267
+ ************************************************************************
268
+ * *
269
+ * 6. Disclaimer of Warranty *
270
+ * ------------------------- *
271
+ * *
272
+ * Covered Software is provided under this License on an "as is" *
273
+ * basis, without warranty of any kind, either expressed, implied, or *
274
+ * statutory, including, without limitation, warranties that the *
275
+ * Covered Software is free of defects, merchantable, fit for a *
276
+ * particular purpose or non-infringing. The entire risk as to the *
277
+ * quality and performance of the Covered Software is with You. *
278
+ * Should any Covered Software prove defective in any respect, You *
279
+ * (not any Contributor) assume the cost of any necessary servicing, *
280
+ * repair, or correction. This disclaimer of warranty constitutes an *
281
+ * essential part of this License. No use of any Covered Software is *
282
+ * authorized under this License except under this disclaimer. *
283
+ * *
284
+ ************************************************************************
285
+
286
+ ************************************************************************
287
+ * *
288
+ * 7. Limitation of Liability *
289
+ * -------------------------- *
290
+ * *
291
+ * Under no circumstances and under no legal theory, whether tort *
292
+ * (including negligence), contract, or otherwise, shall any *
293
+ * Contributor, or anyone who distributes Covered Software as *
294
+ * permitted above, be liable to You for any direct, indirect, *
295
+ * special, incidental, or consequential damages of any character *
296
+ * including, without limitation, damages for lost profits, loss of *
297
+ * goodwill, work stoppage, computer failure or malfunction, or any *
298
+ * and all other commercial damages or losses, even if such party *
299
+ * shall have been informed of the possibility of such damages. This *
300
+ * limitation of liability shall not apply to liability for death or *
301
+ * personal injury resulting from such party's negligence to the *
302
+ * extent applicable law prohibits such limitation. Some *
303
+ * jurisdictions do not allow the exclusion or limitation of *
304
+ * incidental or consequential damages, so this exclusion and *
305
+ * limitation may not apply to You. *
306
+ * *
307
+ ************************************************************************
308
+
309
+ 8. Litigation
310
+ -------------
311
+
312
+ Any litigation relating to this License may be brought only in the
313
+ courts of a jurisdiction where the defendant maintains its principal
314
+ place of business and such litigation shall be governed by laws of that
315
+ jurisdiction, without reference to its conflict-of-law provisions.
316
+ Nothing in this Section shall prevent a party's ability to bring
317
+ cross-claims or counter-claims.
318
+
319
+ 9. Miscellaneous
320
+ ----------------
321
+
322
+ This License represents the complete agreement concerning the subject
323
+ matter hereof. If any provision of this License is held to be
324
+ unenforceable, such provision shall be reformed only to the extent
325
+ necessary to make it enforceable. Any law or regulation which provides
326
+ that the language of a contract shall be construed against the drafter
327
+ shall not be used to construe this License against a Contributor.
328
+
329
+ 10. Versions of the License
330
+ ---------------------------
331
+
332
+ 10.1. New Versions
333
+
334
+ Mozilla Foundation is the license steward. Except as provided in Section
335
+ 10.3, no one other than the license steward has the right to modify or
336
+ publish new versions of this License. Each version will be given a
337
+ distinguishing version number.
338
+
339
+ 10.2. Effect of New Versions
340
+
341
+ You may distribute the Covered Software under the terms of the version
342
+ of the License under which You originally received the Covered Software,
343
+ or under the terms of any subsequent version published by the license
344
+ steward.
345
+
346
+ 10.3. Modified Versions
347
+
348
+ If you create software not governed by this License, and you want to
349
+ create a new license for such software, you may create and use a
350
+ modified version of this License if you rename the license and remove
351
+ any references to the name of the license steward (except to note that
352
+ such modified license differs from this License).
353
+
354
+ 10.4. Distributing Source Code Form that is Incompatible With Secondary
355
+ Licenses
356
+
357
+ If You choose to distribute Source Code Form that is Incompatible With
358
+ Secondary Licenses under the terms of this version of the License, the
359
+ notice described in Exhibit B of this License must be attached.
360
+
361
+ Exhibit A - Source Code Form License Notice
362
+ -------------------------------------------
363
+
364
+ This Source Code Form is subject to the terms of the Mozilla Public
365
+ License, v. 2.0. If a copy of the MPL was not distributed with this
366
+ file, You can obtain one at http://mozilla.org/MPL/2.0/.
367
+
368
+ If it is not possible or desirable to put the notice in a particular
369
+ file, then You may include the notice in a location (such as a LICENSE
370
+ file in a relevant directory) where a recipient would be likely to look
371
+ for such a notice.
372
+
373
+ You may add additional accurate notices of copyright ownership.
374
+
375
+ Exhibit B - "Incompatible With Secondary Licenses" Notice
376
+ ---------------------------------------------------------
377
+
378
+ This Source Code Form is "Incompatible With Secondary Licenses", as
379
+ defined by the Mozilla Public License, v. 2.0.
380
+
381
+ Project-URL: Homepage, https://github.com/dynod/nmk-python
382
+ Project-URL: Repository, https://github.com/dynod/nmk-python
383
+ Project-URL: Issues, https://github.com/dynod/nmk/issues?q=is%3Aopen+is%3Aissue+label%3Aplugin%3Apython
384
+ Classifier: Programming Language :: Python :: 3.9
385
+ Classifier: Programming Language :: Python :: 3.10
386
+ Classifier: Programming Language :: Python :: 3.11
387
+ Classifier: Programming Language :: Python :: 3.12
388
+ Requires-Python: >=3.9
389
+ Description-Content-Type: text/markdown
390
+ License-File: LICENSE
391
+ Requires-Dist: nmk-base>=0.24.0
392
+ Requires-Dist: Jinja2
393
+ Requires-Dist: tomlkit
394
+
395
+ # nmk-python
396
+ Python plugin for nmk build system
397
+
398
+ <!-- NMK-BADGES-BEGIN -->
399
+ [![License: MPL](https://img.shields.io/github/license/dynod/nmk-python?color=green)](https://github.com/dynod/nmk-python/blob/main/LICENSE)
400
+ [![Checks](https://img.shields.io/github/actions/workflow/status/dynod/nmk-python/build.yml?branch=main&label=build%20%26%20u.t.)](https://github.com/dynod/nmk-python/actions?query=branch%3Amain)
401
+ [![Issues](https://img.shields.io/github/issues-search/dynod/nmk?label=issues&query=is%3Aopen+is%3Aissue+label%3Aplugin%3Apython)](https://github.com/dynod/nmk/issues?q=is%3Aopen+is%3Aissue+label%3Aplugin%3Apython)
402
+ [![Supported python versions](https://img.shields.io/badge/python-3.9%20--%203.12-blue)](https://www.python.org/)
403
+ [![PyPI](https://img.shields.io/pypi/v/nmk-python)](https://pypi.org/project/nmk-python/)
404
+ [![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://astral.sh/ruff)
405
+ [![Ruff analysis result](https://img.shields.io/badge/ruff-0-green)](https://astral.sh/ruff)
406
+ [![Code coverage](https://img.shields.io/codecov/c/github/dynod/nmk-python)](https://app.codecov.io/gh/dynod/nmk-python)
407
+ [![Documentation Status](https://readthedocs.org/projects/nmk-python/badge/?version=stable)](https://nmk-python.readthedocs.io/)
408
+ <!-- NMK-BADGES-END -->
409
+
410
+ This plugin adds support for Python development in an **`nmk`** project:
411
+ * project file generation
412
+ * code format and analysis with [ruff](https://astral.sh/ruff)
413
+ * python wheel build
414
+ * test with [pytest](https://pytest.org)
415
+ * VSCode settings generation (if [**`nmk-vscode`**](https://github.com/dynod/nmk-vscode) plugin is also used)
416
+ * README badges generation (if [**`nmk-badges`**](https://github.com/dynod/nmk-badges) plugin is also used):
417
+ * supported python versions
418
+ * link to pypi.org
419
+ * used tools
420
+ * code coverage
421
+
422
+ ## Usage
423
+
424
+ To use this plugin in your **`nmk`** project, insert this reference:
425
+ ```
426
+ refs:
427
+ - pip://nmk-python!plugin.yml
428
+ ```
429
+
430
+ ## Documentation
431
+
432
+ This plugin documentation is available [here](https://nmk-python.readthedocs.io/)
433
+
434
+ ## Issues
435
+
436
+ Issues for this plugin shall be reported on the [main **`nmk`** project](https://github.com/dynod/nmk/issues), using the **plugin:python** label.
@@ -1,18 +1,17 @@
1
1
  nmk_python/__init__.py,sha256=EouCWXbAeObby1vOCx0Vx_WaGC2fEEFDMCen3JZt4TU,446
2
2
  nmk_python/badges.yml,sha256=RAn_0A7NdHb0leF-MdXsVPtS6kOyfsUGb61GBXqDc-8,911
3
- nmk_python/build.py,sha256=8PgpaWqx6jTSc7eZsvNC4h8WhfM9DoB0SqhCK6_BSpA,4898
4
- nmk_python/build.yml,sha256=kgG-_6NyAX25B45plaDEHUMk2RYgaSYyM8y7c952JlQ,2989
3
+ nmk_python/build.py,sha256=JYX284T8PkqIqnQlXN6UoftwwYd1ixuVzsXNVfOV60c,5283
4
+ nmk_python/build.yml,sha256=smmzWpSd3-op19Md0jCOCJqBya9Iu_Y2SsPZdfd7JsY,3324
5
5
  nmk_python/doc.yml,sha256=12amAlYylH7JAHaqBIOoEZ_LrXY_bPNKuHrrwUkIj8w,932
6
- nmk_python/files.py,sha256=T2-MBoc-KEmnhCC78IbGsi6Q-ntk_IcOtWVylLEhSAc,1887
6
+ nmk_python/files.py,sha256=gtPf6ldR5F4oGsAdzFnEIbI9MqqvF3z5JQnyONZmLmk,1863
7
7
  nmk_python/files.yml,sha256=-vGjogdulwsfdKVEUa5RARYDKxF3m9RmHKFnIhaT3_k,780
8
8
  nmk_python/plugin.yml,sha256=hi7osXyIwpHgJAsww5mhOA6emxhzgitDF8cOsvyY29Y,1068
9
- nmk_python/project.py,sha256=83E9tYv3DpKlF-tens7iNfWcj08v2QBxzBWJwuLHTCk,3063
10
- nmk_python/project.yml,sha256=Uq8yKoqOgY2sIQweUJhrLALLFuc76uNmUZsz7hrb9pI,947
11
- nmk_python/ruff.py,sha256=T0o9i_ZZosJDWRuLNkgYIzL9mb_KmNMsmQ1kDq08gBU,1082
9
+ nmk_python/project.yml,sha256=sRIMvKkasrYlIvOo3DsVyNM_sgID_sHVgZg_bSIqtfw,975
10
+ nmk_python/ruff.py,sha256=tfqC66NEB3P1FID1qzP-Ba3hafF02A1I9GIeruGUW2U,1058
12
11
  nmk_python/ruff.yml,sha256=VIlH52dc4m-dgsm-SFuD4-AK6knke1-GuJSJQvVsXWE,1863
13
- nmk_python/tests.py,sha256=nOgi6-Jh0rMQnl0vKqgAFuitiOpQVZmsjdhQZz_vuhc,1236
12
+ nmk_python/tests.py,sha256=8kRKP3dT2Thi5W5sCQSQOPXkV1D9C7tde3QYySo6G2c,1212
14
13
  nmk_python/tests.yml,sha256=8th_7_7nII84URse1dmbhNJ1_l0ZvsRD-C9uhNWJ7GA,1663
15
- nmk_python/version.py,sha256=HFZcZ_ZMxwVOR2OjUFF2cFc2Og3qPo5Bph3PiTDkhHU,3133
14
+ nmk_python/version.py,sha256=fLpOWdujYwlJB7XhWaOGCTeg3gQaClk2YHoRkkW64dE,3109
16
15
  nmk_python/version.yml,sha256=YGvVUnJ0-HjWfyXOzDWqQzLSBF68Fd8cNT6ESHAr6oE,904
17
16
  nmk_python/templates/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
18
17
  nmk_python/templates/build.toml.jinja,sha256=EBuBZpWkphpVj3X1j9s3WIL11-OcLj0u7e19CqxJEDU,902
@@ -20,8 +19,8 @@ nmk_python/templates/pytest.toml.jinja,sha256=zQ3SRWnF23Omxm7zInE54j0l3OyjXSOn5p
20
19
  nmk_python/templates/python-settings.json.jinja,sha256=-6J1tybWEzChxlDqu4tp9BMWxbYD8HpztGs9G8LkC_w,877
21
20
  nmk_python/templates/python-test-debug-launch.json.jinja,sha256=J_xju2EpHNXvgvqBxlf99p7g-ZMh3xE-_2r7o_57gpU,364
22
21
  nmk_python/templates/ruff.toml.jinja,sha256=DTHe1ixK1SBY8d2xBCfkGz89HzjAoMO7Ogs12AY1i4Y,346
23
- nmk_python-0.15.1.dist-info/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
24
- nmk_python-0.15.1.dist-info/METADATA,sha256=H4nqMsSwdZLASMcnB-TYIXZzekRoT6XnBq1cQP7WOH4,2790
25
- nmk_python-0.15.1.dist-info/WHEEL,sha256=GV9aMThwP_4oNCtvEC2ec3qUYutgWeAzklro_0m4WJQ,91
26
- nmk_python-0.15.1.dist-info/top_level.txt,sha256=MCb5w_hoOZ0kk3Dajxrd9Pz6lZ3pyuS6TQCRA3vddTo,11
27
- nmk_python-0.15.1.dist-info/RECORD,,
22
+ nmk_python-0.16.0.dist-info/LICENSE,sha256=HyVuytGSiAUQ6ErWBHTqt1iSGHhLmlC8fO7jTCuR8dU,16725
23
+ nmk_python-0.16.0.dist-info/METADATA,sha256=PFT3I3lQqZBn9X827Kh2k0dso9JZn_kVKklodmXZYdU,22691
24
+ nmk_python-0.16.0.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
25
+ nmk_python-0.16.0.dist-info/top_level.txt,sha256=MCb5w_hoOZ0kk3Dajxrd9Pz6lZ3pyuS6TQCRA3vddTo,11
26
+ nmk_python-0.16.0.dist-info/RECORD,,
@@ -1,5 +1,5 @@
1
1
  Wheel-Version: 1.0
2
- Generator: setuptools (75.1.0)
2
+ Generator: setuptools (75.3.0)
3
3
  Root-Is-Purelib: true
4
4
  Tag: py3-none-any
5
5
 
nmk_python/project.py DELETED
@@ -1,84 +0,0 @@
1
- """
2
- Python project file builder
3
- """
4
-
5
- from pathlib import Path
6
- from typing import Any, List
7
-
8
- from nmk_base.common import TemplateBuilder
9
- from tomlkit import TOMLDocument, comment, loads
10
- from tomlkit.toml_file import TOMLFile
11
-
12
-
13
- class PythonProjectBuilder(TemplateBuilder):
14
- """
15
- Python project file builder
16
- """
17
-
18
- # Handle relative path for all contributions
19
- def _check_paths(self, value: Any):
20
- if isinstance(value, str):
21
- return self.relative_path(value)
22
- if isinstance(value, list):
23
- return list(map(self._check_paths, value))
24
- if isinstance(value, dict):
25
- return {k: self._check_paths(v) for k, v in value.items()}
26
- return value
27
-
28
- def _contribute(self, main: dict, update: dict):
29
- """
30
- Merge items from **update** dictionary into **main** one.
31
- Merge logic for existing items is:
32
-
33
- * for lists: new items are appended after existing ones
34
- * for dictionaries: existing dictionary is updated with new one content
35
- * for other types: existing values are replaces with new ones
36
-
37
- :param main: Settings dictionary to be updated
38
- :param update: Update dictionary to be merged into the existing one
39
- """
40
-
41
- for k, v in update.items():
42
- # Already exists in target model?
43
- if k in main:
44
- # List: extend
45
- if isinstance(v, list):
46
- main[k].extend(self._check_paths(v))
47
- # Map: recursive contribution
48
- elif isinstance(v, dict):
49
- self._contribute(main[k], v)
50
- # Otherwise: replace
51
- else:
52
- main[k] = self._check_paths(v)
53
- else:
54
- # New key
55
- main[k] = self._check_paths(v)
56
-
57
- def build(self, fragment_files: List[str], items: dict):
58
- """
59
- Generates python project file from fragments and items
60
-
61
- :param fragment_files: List of fragment files to be merged
62
- :param items: Dict of project items to be merged
63
- """
64
-
65
- # Merge project fragments to generate final project
66
- project = {}
67
- for f_path in map(Path, fragment_files):
68
- try:
69
- # Update document with rendered template
70
- fragment_doc = loads(self.render_template(f_path, {}))
71
- except Exception as e:
72
- # Propagate error with file name
73
- raise ValueError(f"While loading project file template ({f_path}): {e}") from e
74
- self._contribute(project, fragment_doc.unwrap())
75
-
76
- # Iterate on items contributed through yml project files (only ones contributing maps)
77
- self._contribute(project, {k: v for k, v in items.items() if isinstance(v, dict)})
78
-
79
- # Finally write config to output file
80
- doc = TOMLDocument()
81
- doc.add(comment("Please don't edit: generated by nmk-python plugin"))
82
- doc.update(project)
83
- project_output = TOMLFile(self.main_output)
84
- project_output.write(doc)
@@ -1,60 +0,0 @@
1
- Metadata-Version: 2.1
2
- Name: nmk-python
3
- Version: 0.15.1
4
- Summary: Python plugin for nmk build system
5
- Author: The dynod project
6
- Maintainer: The dynod project
7
- Classifier: Programming Language :: Python :: 3.8
8
- Classifier: Programming Language :: Python :: 3.9
9
- Classifier: Programming Language :: Python :: 3.10
10
- Classifier: Programming Language :: Python :: 3.11
11
- Classifier: Programming Language :: Python :: 3.12
12
- Requires-Python: >=3.8
13
- Description-Content-Type: text/markdown
14
- License-File: LICENSE
15
- Requires-Dist: nmk-base
16
- Requires-Dist: Jinja2
17
- Requires-Dist: tomlkit
18
-
19
- # nmk-python
20
- Python plugin for nmk build system
21
-
22
- <!-- NMK-BADGES-BEGIN -->
23
- [![License: MPL](https://img.shields.io/github/license/dynod/nmk-python?color=green)](https://github.com/dynod/nmk-python/blob/main/LICENSE)
24
- [![Checks](https://img.shields.io/github/actions/workflow/status/dynod/nmk-python/build.yml?branch=main&label=build%20%26%20u.t.)](https://github.com/dynod/nmk-python/actions?query=branch%3Amain)
25
- [![Issues](https://img.shields.io/github/issues-search/dynod/nmk?label=issues&query=is%3Aopen+is%3Aissue+label%3Aplugin%3Apython)](https://github.com/dynod/nmk/issues?q=is%3Aopen+is%3Aissue+label%3Aplugin%3Apython)
26
- [![Supported python versions](https://img.shields.io/badge/python-3.8%20--%203.12-blue)](https://www.python.org/)
27
- [![PyPI](https://img.shields.io/pypi/v/nmk-python)](https://pypi.org/project/nmk-python/)
28
- [![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://astral.sh/ruff)
29
- [![Ruff analysis result](https://img.shields.io/badge/ruff-0-green)](https://astral.sh/ruff)
30
- [![Code coverage](https://img.shields.io/codecov/c/github/dynod/nmk-python)](https://app.codecov.io/gh/dynod/nmk-python)
31
- [![Documentation Status](https://readthedocs.org/projects/nmk-python/badge/?version=stable)](https://nmk-python.readthedocs.io/)
32
- <!-- NMK-BADGES-END -->
33
-
34
- This plugin adds support for Python development in an **`nmk`** project:
35
- * project file generation
36
- * code format and analysis with [ruff](https://astral.sh/ruff)
37
- * python wheel build
38
- * test with [pytest](https://pytest.org)
39
- * VSCode settings generation (if [**`nmk-vscode`**](https://github.com/dynod/nmk-vscode) plugin is also used)
40
- * README badges generation (if [**`nmk-badges`**](https://github.com/dynod/nmk-badges) plugin is also used):
41
- * supported python versions
42
- * link to pypi.org
43
- * used tools
44
- * code coverage
45
-
46
- ## Usage
47
-
48
- To use this plugin in your **`nmk`** project, insert this reference:
49
- ```
50
- refs:
51
- - pip://nmk-python!plugin.yml
52
- ```
53
-
54
- ## Documentation
55
-
56
- This plugin documentation is available [here](https://nmk-python.readthedocs.io/)
57
-
58
- ## Issues
59
-
60
- Issues for this plugin shall be reported on the [main **`nmk`** project](https://github.com/dynod/nmk/issues), using the **plugin:python** label.