D. Bohdan
cd8fd71261
docs(readme): improve writing and terminology
...
[skip ci]
2024-02-25 19:06:16 +00:00
D. Bohdan
6ecfb0b823
docs(readme): update, rename limitations section
2024-02-20 15:05:01 +00:00
D. Bohdan
16d8b762b1
feat!(json): only convert values to strs with `-k`
...
BREAKING CHANGE: Make string conversion of keys and values consistent;
require `-k`/`--stringify`.
2024-02-17 20:00:04 +00:00
D. Bohdan
d02a4fde8b
docs(readme): rephrase; update examples
...
Replace the weather API example with one that works without an API key today.
2024-02-14 10:13:26 +00:00
D. Bohdan
c6a45370c7
feat(yaml): switch from YAML 1.1 to YAML 1.2
...
Migrate from PyYAML to ruamel.yaml.
Drop support for `--sort-keys` for YAML output.
Replace the keyword argument `ordered` with `sort_keys`.
Create a dataclass for `yaml_options` arguments.
2024-02-13 19:51:42 +00:00
D. Bohdan
05333e65c6
docs(readme): improve phrasing; link to TOML 1.0.0
2024-02-13 12:49:02 +00:00
D. Bohdan
71e6139f63
docs(readme): give pipx cmd for dev version inst
2023-11-28 18:09:13 +00:00
D. Bohdan
be696d323d
feat(cli): wrap metavars in angle brackets
...
This will distinguish them from literals.
2023-10-19 10:32:30 +00:00
D. Bohdan
9835e66a0e
feat(cli): clarify "wrap" is opt in TOML error msg
...
[skip ci]
2023-10-19 10:20:35 +00:00
D. Bohdan
e85e0d3357
docs(readme): make more stylistic chnages
2023-10-19 10:12:21 +00:00
D. Bohdan
5f01cd02e6
docs(readme): use `<wbr>` in lengthy command exprs
...
Instead of manually breaking them up into two parts.
[skip ci]
2023-10-19 10:04:50 +00:00
D. Bohdan
907919a390
docs(readme): make small stylistic edits
2023-10-19 10:02:10 +00:00
D. Bohdan
e255a6e2dc
docs(readme): rm `.py` ext from usage, examples
...
[skip ci]
2023-10-19 09:15:28 +00:00
D. Bohdan
71d95800ef
feat(cli): hide `--indent-json` from help
2023-10-06 09:23:40 +00:00
D. Bohdan
76cae2b212
docs(readme): make more clear PyPI link is to pkg
2023-09-28 10:32:09 +00:00
D. Bohdan
5bc1090fa4
docs(readme): wrap usage at 80 columns
2023-09-28 09:17:45 +00:00
D. Bohdan
c08bf7636e
feat(cli): add `-f`/`-t`; hide `-if`/`-of` in help
...
`-f`/`--from` and `-t`/`--to` copy Pandoc and iconv(1).
`-if` and `-of` (with a single dash) are legacy options
from the Go days of Remarshal.
They are long overdue for hiding.
2023-09-28 09:17:45 +00:00
D. Bohdan
c1b2ef082c
feat(cli): add `--verbose` flag
...
Remove the function `remarshal.run`.
We can't keep using it from `main` with `--verbose`.
2023-09-28 09:17:45 +00:00
D. Bohdan
f1900464d6
docs(readme): adopt semantic line breaks
2023-09-13 12:29:03 +00:00
D. Bohdan
059e26decd
feat: increase `--max-values` default to 1000000
...
100000 isn't enough for some random "large" files I have found in the
wild (a few megabytes in size), but 1000000 is.
2023-09-05 13:58:35 +00:00
D. Bohdan
7c64271e4c
docs(readme): update usage
...
[skip ci]
2023-09-05 13:16:56 +00:00
D. Bohdan
3b2c696d21
feat(cli): write "date-time" with dash
...
"datetime" will look strange to a user who doesn't know Python. It
exposes internals that may change. (What if we adopt a special class for
times without dates?) Let us instead pick something very close from
natural language.
2023-08-10 16:25:09 +00:00
D. Bohdan
794a4dc070
feat(cli): do not use "stringify" in help message
2023-08-10 16:11:18 +00:00
D. Bohdan
a14c334f14
docs(readme): update usage
2023-08-10 15:31:59 +00:00
D. Bohdan
e661536c3f
docs(readme): update usage; remove short cmd usage
2023-08-09 21:45:51 +00:00
D. Bohdan
f0e9add739
feat!(cli): add `-k`/`--stringify-keys` flag
...
BREAKING CHANGE: make it no longer the default to stringify keys when
converting to JSON. This is being done to avoid silent incorrect
conversions and to turn them into errors. For example, GitHub Actions
workflows with an `on` YAML key are currently converted incorrectly.
Support stringifying keys for TOML.
v0.17.0
2023-08-09 21:45:51 +00:00
D. Bohdan
05c0035e0d
docs(readme): update install instructions
...
Break up long lines.
[skip ci]
2023-08-01 17:35:52 +00:00
D. Bohdan
725700ad41
docs(readme): add `pipx install` command
2023-07-19 14:33:36 +00:00
D. Bohdan
ef9cdb62a9
docs(readme): rm empty str arg for stdin/stdout
2023-07-19 11:59:26 +00:00
D. Bohdan
0284a54d78
docs(readme): place `2cbor` help first
2023-07-18 21:42:14 +00:00
D. Bohdan
56ddad2e9d
feat(encode): preserve order by default; add `-s`
2023-07-18 21:40:09 +00:00
D. Bohdan
b259420e1e
feat(encode_yaml): add indent, width option
...
Add, recommend `--json-indent` for consistency.
v0.16.0
2023-07-18 21:18:48 +00:00
D. Bohdan
c885a51850
docs(readme): rec pip with git for dev version
...
Current instructions are optimized for making your own modifications,
which most users don't need.
2023-07-14 10:57:29 +00:00
D. Bohdan
8aff3d309e
docs(readme): fix typo in pipx command
2023-07-14 10:56:42 +00:00
D. Bohdan
dce43fdf22
docs(readme): use `poetry version`; improve style
2023-07-14 10:35:44 +00:00
D. Bohdan
7aa6b61213
docs(readme): add pipx command
2023-07-14 09:34:50 +00:00
D. Bohdan
8c87aaad1d
docs(readme): update Python version requirement
2023-07-11 09:48:40 +00:00
D. Bohdan
42346fe9f9
docs(readme): do not use double space after period
2023-07-11 09:47:09 +00:00
D. Bohdan
c0e2d346bb
docs: capitalize "Remarshal"
2023-07-08 17:28:49 +00:00
D. Bohdan
1a208578b7
docs(readme): reword note on date/time limitations
2020-10-21 11:40:11 +00:00
D. Bohdan
95c2142406
docs(readme): fix, expand info on date limitations
2020-10-21 11:37:41 +00:00
D. Bohdan
ab727c2cf4
docs(readme): simplify phrase in "Wrappers"
2020-09-15 09:30:38 +00:00
D. Bohdan
cc88c5c79e
docs(readme): update known limitations
2020-09-15 09:27:46 +00:00
D. Bohdan
61d57795d9
refactor: drop Python 2.7, Python 3.5
2020-09-15 08:58:39 +00:00
D. Bohdan
778057b519
docs(readme): remove CI badges
...
With the build status indicator on GitHub they are redundant.
2020-09-15 08:58:28 +00:00
D. Bohdan
bf03a22ae8
docs(readme/wrappers): mention CBOR in section
2020-06-02 20:58:29 +00:00
D. Bohdan
db99504a0c
docs(readme): upd dev version install instructions
2020-06-02 20:39:00 +00:00
Felipe Gasper
c090a71724
docs(readme): list CBOR before JSON
2020-03-13 16:44:26 +00:00
Felipe Gasper
9638e82981
test(cbor): restore Python 2 compat
...
List CBOR before JSON and the others in the docs.
2020-03-13 16:42:50 +00:00
Felipe Gasper
9789af5f89
test(cbor): add another test
...
Update the README.
2020-03-13 16:41:20 +00:00