yamark 0.2.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.
Binary file
@@ -0,0 +1,151 @@
1
+ Metadata-Version: 2.4
2
+ Name: yamark
3
+ Version: 0.2.0
4
+ Classifier: Development Status :: 4 - Beta
5
+ Classifier: Environment :: Console
6
+ Classifier: License :: OSI Approved :: MIT License
7
+ Classifier: Programming Language :: Rust
8
+ Classifier: Topic :: Text Processing :: Markup
9
+ License-File: LICENSE
10
+ Summary: Format YAML and Markdown with yamark.
11
+ Keywords: formatter,markdown,yaml
12
+ Home-Page: https://t-kalinowski.github.io/yamark/
13
+ License-Expression: MIT
14
+ Requires-Python: >=3.8
15
+ Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
16
+ Project-URL: Documentation, https://t-kalinowski.github.io/yamark/
17
+ Project-URL: Homepage, https://t-kalinowski.github.io/yamark/
18
+ Project-URL: Issues, https://github.com/t-kalinowski/yamark/issues
19
+ Project-URL: Repository, https://github.com/t-kalinowski/yamark
20
+
21
+ # Yamark
22
+
23
+ Yamark formats YAML, Markdown, Markdown files with YAML front matter,
24
+ and explicit embedded Markdown targets in Python and R source files. It
25
+ rewrites supported regions and preserves unsupported input. Pass
26
+ `--verify` to reparse changed YAML and reject invalid or value-changing
27
+ output.
28
+
29
+ ## Install
30
+
31
+ Run Yamark from PyPI without installing it:
32
+
33
+ ```sh
34
+ uvx yamark format config.yaml docs/
35
+ ```
36
+
37
+ Install the command from PyPI:
38
+
39
+ ```sh
40
+ uv tool install yamark
41
+ ```
42
+
43
+ Build and install the binary from a checkout:
44
+
45
+ ```sh
46
+ cargo build --bin yamark
47
+ cargo install --path .
48
+ ```
49
+
50
+ Build a Python wheel from a checkout for local testing:
51
+
52
+ ```sh
53
+ uvx maturin build --release
54
+ ```
55
+
56
+ ## Usage
57
+
58
+ Format one or more files or directories in place:
59
+
60
+ ```sh
61
+ yamark format config.yaml docs/
62
+ ```
63
+
64
+ Format the current directory:
65
+
66
+ ```sh
67
+ yamark format
68
+ ```
69
+
70
+ Check whether files are already formatted without writing changes:
71
+
72
+ ```sh
73
+ yamark format --check docs/
74
+ ```
75
+
76
+ Show a unified diff without writing changes:
77
+
78
+ ```sh
79
+ yamark format --diff docs/
80
+ ```
81
+
82
+ Format stdin for editor and CI integrations:
83
+
84
+ ```sh
85
+ yamark format --stdin-file-path config.yaml < config.yaml
86
+ ```
87
+
88
+ Directory traversal respects `.gitignore`, `.ignore`, and global Git
89
+ ignore files by default.
90
+
91
+ ## Development
92
+
93
+ Run the Rust test suite with:
94
+
95
+ ```sh
96
+ cargo test
97
+ ```
98
+
99
+ Run formatting and lint checks with:
100
+
101
+ ```sh
102
+ cargo fmt --check
103
+ cargo clippy --all-targets --all-features -- -D warnings
104
+ ```
105
+
106
+ Run the external CLI test suite with:
107
+
108
+ ```sh
109
+ uv run external-tests/run.py
110
+ ```
111
+
112
+ Run the VS Code extension tests with:
113
+
114
+ ```sh
115
+ cd editors/vscode
116
+ npm test
117
+ ```
118
+
119
+ The YAML test-suite roundtrip integration test runs automatically when
120
+ `tests/yaml-test-suite/data` exists. Populate that fixture directory
121
+ with:
122
+
123
+ ```sh
124
+ tools/bootstrap-yaml-test-suite-data.py --source ~/github/posit-dev/r-yaml12/tests/testthat/yaml-test-suite
125
+ ```
126
+
127
+ Use `website/reference.qmd` and the public CLI tests as behavior
128
+ references.
129
+
130
+ ## Release
131
+
132
+ Update the package versions in `Cargo.toml`, `pyproject.toml`, and
133
+ `editors/vscode/package.json`, refresh `Cargo.lock` and `uv.lock`, then
134
+ push a matching `vX.Y.Z` tag:
135
+
136
+ ```sh
137
+ git tag v0.2.0
138
+ git push origin v0.2.0
139
+ ```
140
+
141
+ The release workflow validates the tag, builds binary archives and
142
+ Python distributions, smoke-tests each wheel, creates the GitHub release
143
+ with generated release notes, and publishes the Python distributions to
144
+ PyPI.
145
+
146
+ ## Editor Integrations
147
+
148
+ The VS Code and Positron formatter extension lives in `editors/vscode/`;
149
+ see `editors/vscode/README.md` for install and local development
150
+ instructions.
151
+
@@ -0,0 +1,6 @@
1
+ yamark-0.2.0.data/scripts/yamark.exe,sha256=SUa8Cc2AzCGXwenZTOsV3KSm8SIjDoGIoy5y4QTM7Vw,4027392
2
+ yamark-0.2.0.dist-info/METADATA,sha256=xb2pXJQlXZhe5itz-oP82NDdBTeSPBK2kYJsRzoEDpg,3477
3
+ yamark-0.2.0.dist-info/WHEEL,sha256=2zDlIYIdD4m4N3p5DVEG3iJhGLdhsBQgdH-FqVkAur8,94
4
+ yamark-0.2.0.dist-info/licenses/LICENSE,sha256=cj4as5FUWwhyBE7KQA2PsJymMgHzvJ6sh7xtrTFEbDE,1095
5
+ yamark-0.2.0.dist-info/sboms/yamark.cyclonedx.json,sha256=yaMQeEvmtP020pymorykCYsCGuooppH5SOI-WXTaR_w,59103
6
+ yamark-0.2.0.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: maturin (1.14.1)
3
+ Root-Is-Purelib: false
4
+ Tag: py3-none-win_amd64
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Tomasz Kalinowski
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.