speja 0.14.0__py3-none-win_amd64.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.
speja/__init__.py ADDED
@@ -0,0 +1,29 @@
1
+ """speja: a VHDL formatter and style checker with VSG-compatible rules and configuration.
2
+
3
+ The package ships the ``speja`` executable. :func:`find_speja_bin` returns its path, for
4
+ tools that want to run it without relying on ``PATH``.
5
+ """
6
+
7
+ from __future__ import annotations
8
+
9
+ import os
10
+ import sys
11
+ import sysconfig
12
+
13
+ __all__ = ["find_speja_bin"]
14
+
15
+
16
+ def find_speja_bin() -> str:
17
+ """Return the path of the ``speja`` executable installed with this package."""
18
+ exe = "speja.exe" if sys.platform == "win32" else "speja"
19
+ candidates = [
20
+ sysconfig.get_path("scripts"),
21
+ sysconfig.get_path("scripts", scheme=sysconfig.get_preferred_scheme("user")),
22
+ # `pip install --target <dir>` puts scripts in `<dir>/bin`.
23
+ os.path.join(os.path.dirname(os.path.dirname(os.path.abspath(__file__))), "bin"),
24
+ ]
25
+ for directory in candidates:
26
+ path = os.path.join(directory, exe)
27
+ if os.path.isfile(path):
28
+ return path
29
+ raise FileNotFoundError(f"could not find {exe} in {candidates}")
speja/__main__.py ADDED
@@ -0,0 +1,22 @@
1
+ """``python -m speja``: run the bundled ``speja`` executable."""
2
+
3
+ from __future__ import annotations
4
+
5
+ import os
6
+ import subprocess
7
+ import sys
8
+
9
+ from speja import find_speja_bin
10
+
11
+
12
+ def main() -> int:
13
+ exe = find_speja_bin()
14
+ if sys.platform == "win32":
15
+ # `exec` does not replace the process on Windows; forward the exit code instead.
16
+ return subprocess.run([exe, *sys.argv[1:]], check=False).returncode
17
+ os.execv(exe, [exe, *sys.argv[1:]])
18
+ return 0 # unreachable
19
+
20
+
21
+ if __name__ == "__main__":
22
+ sys.exit(main())
Binary file
@@ -0,0 +1,307 @@
1
+ Metadata-Version: 2.4
2
+ Name: speja
3
+ Version: 0.14.0
4
+ Classifier: Development Status :: 4 - Beta
5
+ Classifier: Environment :: Console
6
+ Classifier: Intended Audience :: Developers
7
+ Classifier: Operating System :: MacOS
8
+ Classifier: Operating System :: Microsoft :: Windows
9
+ Classifier: Operating System :: POSIX :: Linux
10
+ Classifier: Programming Language :: Python :: 3
11
+ Classifier: Programming Language :: Python :: 3 :: Only
12
+ Classifier: Programming Language :: Python :: 3.10
13
+ Classifier: Programming Language :: Python :: 3.11
14
+ Classifier: Programming Language :: Python :: 3.12
15
+ Classifier: Programming Language :: Python :: 3.13
16
+ Classifier: Programming Language :: Python :: 3.14
17
+ Classifier: Programming Language :: Rust
18
+ Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
19
+ Classifier: Topic :: Software Development :: Quality Assurance
20
+ License-File: LICENSE-MIT
21
+ License-File: LICENSE-APACHE
22
+ License-File: THIRD_PARTY_LICENSES.md
23
+ Summary: Catch VHDL bugs before simulation: a fast Rust formatter and linter with VSG-compatible rules and configuration.
24
+ Keywords: vhdl,formatter,linter,vsg,fpga
25
+ License-Expression: MIT OR Apache-2.0
26
+ Requires-Python: >=3.10
27
+ Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
28
+ Project-URL: Documentation, https://github.com/ru551n/speja/tree/main/docs
29
+ Project-URL: Repository, https://github.com/ru551n/speja
30
+
31
+ <p align="center">
32
+ <picture>
33
+ <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/ru551n/speja/main/docs/assets/speja-logo-dark.png">
34
+ <img src="https://raw.githubusercontent.com/ru551n/speja/main/docs/assets/speja-logo.png" alt="" width="128">
35
+ </picture>
36
+ </p>
37
+
38
+ # speja
39
+
40
+ [![CI](https://github.com/ru551n/speja/actions/workflows/ci.yml/badge.svg)](https://github.com/ru551n/speja/actions/workflows/ci.yml)
41
+ [![Documentation](https://readthedocs.org/projects/speja/badge/?version=latest)](https://speja.readthedocs.io/)
42
+ [![PyPI](https://img.shields.io/pypi/v/speja)](https://pypi.org/project/speja/)
43
+ [![License](https://img.shields.io/badge/license-MIT%20OR%20Apache--2.0-blue)](#licence)
44
+
45
+ **Catch it earlier. Earlier than simulation.**
46
+
47
+ A VHDL formatter and linter in Rust. Every bug has a price that goes up the longer it takes to
48
+ find: a moment in your editor, a coffee in CI, an afternoon in a waveform viewer, a respin on
49
+ silicon. speja moves what it can to the cheap end of that scale: the moment you save the file.
50
+
51
+ Some of what it reports a simulator would have told you eventually: an index outside its array,
52
+ a value outside its subtype, a process that can never suspend. *Eventually* means after you have
53
+ written the testbench, elaborated the design and waited for the run, and only if the run reaches
54
+ that line. Some of it no simulator will ever tell you, because the design elaborates perfectly
55
+ well and simply does not mean what it says.
56
+
57
+ It runs the rule set, command line and configuration of the
58
+ [VHDL Style Guide](https://vhdl-style-guide.readthedocs.io/) (VSG), adds a formatter that fixes
59
+ what it reports, and adds a lint layer that VSG has no equivalent of.
60
+
61
+ A default lint run reports **definite errors only**: things that cannot work, rather than things
62
+ worth a look. Everything that depends on what you meant is one line of configuration away.
63
+
64
+ **Status: beta.** The style layer implements VSG 3.35's rule set and is tested against more than
65
+ 11,000 real-world files; expect layout changes before 1.0. The lint layer (`speja lint`) is
66
+ newer and its rule set is still growing.
67
+
68
+ ## Install
69
+
70
+ ```sh
71
+ pip install speja # Linux, Windows and macOS wheels, Python 3.10+
72
+ uv tool install speja # or
73
+ cargo install --path . # from source (Rust 1.95 or newer)
74
+ ```
75
+
76
+ Standalone binaries for Linux (static, x86_64 and aarch64), Windows (x64 and arm64) and macOS
77
+ (arm64 and x86_64) are attached to each
78
+ [release](https://github.com/ru551n/speja/releases), with a `SHA256SUMS` file.
79
+
80
+ ## Everything VSG accepts, unchanged
81
+
82
+ ```sh
83
+ speja -f src/*.vhd -c vsg.yaml --fix
84
+ ```
85
+
86
+ The arguments, the configuration file, the reports and the exit codes are VSG's, and
87
+ [VSG documents them](https://vhdl-style-guide.readthedocs.io/en/latest/usage.html). Existing
88
+ scripts and CI jobs keep working, so this README covers only what speja adds on top.
89
+ Differences are listed in
90
+ [compatibility](https://speja.readthedocs.io/en/latest/compatibility/).
91
+
92
+ ## What speja adds
93
+
94
+ **A real formatter.** Source is parsed once into a lossless syntax tree and printed in one
95
+ canonical layout, like rustfmt or Black. Every layout rule is fixed rather than reported, long
96
+ lines are folded at structural boundaries, and running `--fix` twice changes nothing. All
97
+ violations are reported at once and fixed in a single pass: no repeated runs, no rule-order
98
+ dependencies.
99
+
100
+ **Safety.** Formatted output is re-parsed and must contain exactly the same tokens and comments;
101
+ files with syntax errors are never changed. Fixes VSG does not apply by default need
102
+ `--unsafe_fixes`.
103
+
104
+ **Speed.** Real-world VHDL is checked at about 3.4 MB/s on one core, in parallel worker
105
+ processes.
106
+
107
+ ### Beyond style: `speja lint`
108
+
109
+ Rules that need names resolved, which a per-file style checker cannot do:
110
+
111
+ ```sh
112
+ speja lint --recursive src # the lint layer
113
+ speja --recursive src --check style,lint # both in one run
114
+ ```
115
+
116
+ ```
117
+ lint_600 -- Signal 'flag' is not assigned on every path of this combinational process,
118
+ which infers a latch
119
+ lint_601 -- Signal 'result' is assigned by 2 concurrent statements (lines 34, 38)
120
+ lint_001 -- The signal 'b' is not read in the sensitivity list (first read at line 10)
121
+ ```
122
+
123
+ Sensitivity lists, unused declarations, latch inference, multiple drivers, combinational loops,
124
+ state machines, vector widths, clock-domain crossings, and the type and name diagnostics of a
125
+ real front end. Every rule states the evidence behind it and reports nothing when that evidence
126
+ is missing.
127
+
128
+ Most of these resolve names across files, which needs a library map. Without one they are
129
+ skipped, and the run says so. See
130
+ [static analysis](https://speja.readthedocs.io/en/latest/lint/) and
131
+ [project setup](https://speja.readthedocs.io/en/latest/project-setup/).
132
+
133
+ ### Adopting a rule set on existing code
134
+
135
+ ```sh
136
+ speja --recursive src --generate_waivers waivers.yaml # accept what exists today
137
+ speja --recursive src --waivers waivers.yaml # from now on, only new violations
138
+ ```
139
+
140
+ [Waivers](https://speja.readthedocs.io/en/latest/waivers/) record a rule, a file glob, lines and
141
+ a reason, and never affect the exit code.
142
+
143
+ ### Options speja adds
144
+
145
+ | Option | Meaning |
146
+ |---|---|
147
+ | `lint`, `--check style,lint` | run the lint layer, or both layers |
148
+ | `--lint_configuration FILE` (`-lc`) | configuration for the lint layer only |
149
+ | `--waivers`, `--generate_waivers`, `--show_waived` | accept known violations |
150
+ | `--unsafe_fixes` | also apply fixes VSG does not apply by default; review the result |
151
+ | `--diff` | with `--fix`, print a unified diff instead of changing files |
152
+ | `--range START:END` | with `--fix`, change only these lines |
153
+ | `--stdin_filename PATH` | name of the `--stdin` input, for configuration lookup and reports |
154
+ | `--sarif FILE` | SARIF 2.1.0, for GitHub code scanning |
155
+ | `--sonarqube FILE` | SonarQube generic issue JSON |
156
+ | `--recursive` | check the VHDL files in directories and their subdirectories |
157
+ | `--list_rules`, `--statistics` | what each rule is, and how often each fired |
158
+
159
+ Configuration keys speja adds live under a `speja:` block: `reflow_comments`,
160
+ `testbench_files`, `testbench_libraries`, `synchronizers`, and a `rule:` block per kind of
161
+ file.
162
+
163
+ ### Editors and coding agents
164
+
165
+ Two servers over stdio, both the same engine as the command line, so everything is told the same
166
+ thing about the same file under the same configuration.
167
+
168
+ ```sh
169
+ speja lsp # a language server: diagnostics, formatting, quick fixes
170
+ speja mcp # an MCP server, for a coding agent
171
+ ```
172
+
173
+ The [language server](https://speja.readthedocs.io/en/latest/lsp/) is meant to run beside
174
+ `vhdl_ls` rather than instead of it, and advertises only what speja is: it answers no
175
+ completion, hover or definition request. A [VS Code extension](editors/vscode/README.md) ships
176
+ it, and adds [editing actions](https://speja.readthedocs.io/en/latest/vscode-editing/) built on
177
+ VHDL-LS, such as instantiating an entity and declaring a port map's signals. Those need VHDL-LS
178
+ running; lint and format do not.
179
+
180
+ The [MCP server](https://speja.readthedocs.io/en/latest/mcp/) gives a coding agent three tools,
181
+ `lint`, `format` and `explain_rule`:
182
+
183
+ ```sh
184
+ claude mcp add speja -- speja mcp
185
+ ```
186
+
187
+ ```json
188
+ { "mcpServers": { "speja": { "command": "speja", "args": ["mcp"] } } }
189
+ ```
190
+
191
+ `lint` and `format` take a file path or a buffer. A buffer is how an agent checks what it is
192
+ about to write before writing it, which is one step earlier still; `format` with `write` fixes a
193
+ file in place without moving it through the conversation.
194
+
195
+ For Claude Code there is a plugin, which installs a `vsg` skill and registers the MCP server:
196
+
197
+ ```text
198
+ /plugin marketplace add ru551n/speja
199
+ /plugin install speja@speja
200
+ ```
201
+
202
+ The skill tells an agent to format and check VHDL before committing it, how to read a finding's
203
+ class, and not to treat a run that skipped the library map as a clean file. `speja` itself still
204
+ has to be on `PATH`.
205
+
206
+ ### CI
207
+
208
+ A [GitHub Action](https://speja.readthedocs.io/en/latest/github-action/) posts annotations and
209
+ suggested changes; [GitLab CI](https://speja.readthedocs.io/en/latest/gitlab-ci/) gets the
210
+ code-quality report, and SonarQube the generic issue JSON. Jenkins reads the SARIF file through
211
+ Warnings-NG. Every [report format](https://speja.readthedocs.io/en/latest/reports/) works
212
+ anywhere.
213
+
214
+ ```yaml
215
+ - uses: ru551n/speja@v0.14.0
216
+ with:
217
+ args: --recursive src
218
+ ```
219
+
220
+ ## Documentation
221
+
222
+ **[speja.readthedocs.io](https://speja.readthedocs.io/)**: what speja adds on top of VSG. The
223
+ rules, their options and the configuration file are VSG's own and are linked to rather than
224
+ repeated.
225
+
226
+ * [Quick start](https://speja.readthedocs.io/en/latest/quick-start/)
227
+ * [Static analysis](https://speja.readthedocs.io/en/latest/lint/) and
228
+ [project setup](https://speja.readthedocs.io/en/latest/project-setup/)
229
+ * [Rule reference](https://speja.readthedocs.io/en/latest/rule-reference/)
230
+ * [Running in an airgap](https://speja.readthedocs.io/en/latest/airgapped/): what it needs, what
231
+ it cannot reach, and how to check both yourself
232
+ * [Language server](https://speja.readthedocs.io/en/latest/lsp/),
233
+ [MCP server](https://speja.readthedocs.io/en/latest/mcp/) and
234
+ [Claude Code plugin](https://speja.readthedocs.io/en/latest/claude-code/)
235
+ * [Waivers](https://speja.readthedocs.io/en/latest/waivers/)
236
+ * [Migrating from VSG](https://speja.readthedocs.io/en/latest/migrating-from-vsg/)
237
+ * [Compatibility with VSG](https://speja.readthedocs.io/en/latest/compatibility/), measured
238
+ weekly against two corpora
239
+
240
+ ## Disclosure: this code was written by an LLM
241
+
242
+ Most of this repository was written by Claude, directed and reviewed by a human. Treat that as a
243
+ reason to check it rather than a reason to trust it, so here is what there is to check against.
244
+ None of it depends on the code having been written well.
245
+
246
+ **It cannot reach anything.** No network, proven four ways in CI on every change: no dependency
247
+ is an HTTP or TLS client, the binary imports no symbol that can reach a host, everything runs
248
+ inside an empty network namespace, and `strace` records zero network syscalls. You can run those
249
+ same checks against the binary you downloaded in about five minutes:
250
+ [running in an airgap](https://speja.readthedocs.io/en/latest/airgapped/).
251
+
252
+ **It cannot quietly mangle your files.** Formatted output is re-parsed and must contain exactly
253
+ the same tokens and comments, in the same order, before anything is written. A mismatch is an
254
+ internal error and your file is left untouched, so a formatter bug costs you a run rather than a
255
+ file. Files with syntax errors are never modified, writes are atomic through a temporary file in
256
+ the same directory, and a file whose output equals its input is not rewritten at all.
257
+
258
+ **Its blast radius is small.** `#![forbid(unsafe_code)]`. No privileges, no service, no daemon,
259
+ no telemetry. The only state it keeps is a 2.3 MB cache of the embedded `ieee` and `std` sources,
260
+ written once per version. The only time it starts another program is `--local_rules`, which runs
261
+ the VSG on your `PATH`, because only VSG can run VSG's Python plugins.
262
+
263
+ **It is checked against reality, not against itself.** The formatter is compared with VSG's own
264
+ output over a corpus of real VHDL, weekly. Every lint rule must report nothing on three real
265
+ projects unless a person has confirmed each finding is a genuine defect, and those counts are a
266
+ CI gate. Fuzzing runs nightly. Agreement is
267
+ [published per rule](https://speja.readthedocs.io/en/latest/compatibility/) rather than claimed.
268
+
269
+ **Known limits, stated rather than buried.** A dependency (`vhdl_lang`) can stack-overflow on
270
+ pathological input, which aborts the process before anything is written. A file you made
271
+ read-only is still replaced, because atomic writes need permission on the directory rather than
272
+ on the file. Both are in the
273
+ [airgap page](https://speja.readthedocs.io/en/latest/airgapped/).
274
+
275
+ Cautious first run? `--fix --diff` changes nothing and prints what it would do, `--backup` keeps
276
+ a copy beside each file, and a run without `--fix` never writes anything at all.
277
+
278
+ ## Relationship to VSG
279
+
280
+ > **speja is an independent Rust implementation of a VHDL formatter and style checker that aims
281
+ > for compatibility with the rules and configuration of the VHDL Style Guide (VSG). It is not
282
+ > affiliated with, endorsed by, or maintained by the VHDL Style Guide project or its
283
+ > maintainers.**
284
+ >
285
+ > speja was inspired by the
286
+ > [VHDL Style Guide (VSG)](https://github.com/jeremiah-c-leary/vhdl-style-guide) project by
287
+ > Jeremiah Leary and contributors. speja contains no VSG code; VSG is used only as a behavioural
288
+ > reference.
289
+
290
+ Every release states the VSG version it targets, and `speja --version` prints it.
291
+
292
+ ## Contributing
293
+
294
+ See [CONTRIBUTING.md](CONTRIBUTING.md) for the build, test and corpus commands, how compatibility
295
+ is measured, and what CI runs.
296
+
297
+ ## Licence
298
+
299
+ Either [Apache License, Version 2.0](LICENSE-APACHE) or [MIT](LICENSE-MIT), at your option.
300
+ Third-party dependencies are listed in [THIRD_PARTY_LICENSES.md](THIRD_PARTY_LICENSES.md) and in
301
+ [NOTICE](NOTICE); the VHDL parser, `vhdl_syntax` from the rust_hdl project, is MPL-2.0 and is
302
+ used as an unmodified dependency.
303
+
304
+ Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in
305
+ speja, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
306
+ additional terms or conditions.
307
+
@@ -0,0 +1,10 @@
1
+ speja/__init__.py,sha256=WAOm2j79e2mMbfaSwFYAQKv-OZE-Ny6N7QDQ-RIDRAU,1060
2
+ speja/__main__.py,sha256=k4XWHvHOIScov1bKnCxv_7yQkVr-MRPtzsC7n8ZDo4Y,560
3
+ speja-0.14.0.data/scripts/speja.exe,sha256=NBsUsmJ7Gm5TlFDRjz05JnWBwoN7Jc6rWEuUi99XIBU,14280192
4
+ speja-0.14.0.dist-info/METADATA,sha256=Fq9u3eM98--8ok_j1G3XjaMQQW3nA5YctKjGzpSMOLw,15106
5
+ speja-0.14.0.dist-info/WHEEL,sha256=8Aej0W0a6Cz6apA3IzJrTnxLRVLAt-w0Oh8SA3Con_c,94
6
+ speja-0.14.0.dist-info/licenses/LICENSE-APACHE,sha256=fP1zjFPWHHnwfjSPYiv3cHyQhCNwVNN_vgd4inX1iBw,11048
7
+ speja-0.14.0.dist-info/licenses/LICENSE-MIT,sha256=5nogDSWJW1DjZ0BXlg0yBRghqctrwvo8c5w14pio-pM,1091
8
+ speja-0.14.0.dist-info/licenses/THIRD_PARTY_LICENSES.md,sha256=5YRm9Gpf9ZeFis2Vu1rzBgj6enSa-B_k6w-hPfdjqM4,9276
9
+ speja-0.14.0.dist-info/sboms/speja.cyclonedx.json,sha256=UUykkZjLSJq8LNmeGHcsoWUxssidhed33AqEDJJgmDw,130274
10
+ speja-0.14.0.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: maturin (1.15.0)
3
+ Root-Is-Purelib: false
4
+ Tag: py3-none-win_amd64
@@ -0,0 +1,201 @@
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 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 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 those 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
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
@@ -0,0 +1,25 @@
1
+ Copyright (c) 2026 The speja contributors
2
+
3
+ Permission is hereby granted, free of charge, to any
4
+ person obtaining a copy of this software and associated
5
+ documentation files (the "Software"), to deal in the
6
+ Software without restriction, including without
7
+ limitation the rights to use, copy, modify, merge,
8
+ publish, distribute, sublicense, and/or sell copies of
9
+ the Software, and to permit persons to whom the Software
10
+ is furnished to do so, subject to the following
11
+ conditions:
12
+
13
+ The above copyright notice and this permission notice
14
+ shall be included in all copies or substantial portions
15
+ of the Software.
16
+
17
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
18
+ ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
19
+ TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
20
+ PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
21
+ SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
22
+ CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
23
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
24
+ IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
25
+ DEALINGS IN THE SOFTWARE.