Skip to content

Commit f3e0040

Browse files
committed
first
1 parent 4721c8d commit f3e0040

File tree

7 files changed

+79
-20
lines changed

7 files changed

+79
-20
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,11 @@ body:
5151
description: |
5252
Please provide:
5353
- Python version
54-
- toon-format version
54+
- python-toon version
5555
- Operating system
5656
placeholder: |
5757
- Python 3.12.0
58-
- toon-format 0.1.0
58+
- python-toon 1.0.0
5959
- macOS 14.0
6060
validations:
6161
required: true

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 65 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,24 +42,83 @@ Closes #
4242

4343
- [ ] All existing tests pass
4444
- [ ] Added new tests for changes
45+
- [ ] Tested on Python 3.8
46+
- [ ] Tested on Python 3.9
47+
- [ ] Tested on Python 3.10
4548
- [ ] Tested on Python 3.11
4649
- [ ] Tested on Python 3.12
47-
- [ ] Tested on Python 3.13
48-
- [ ] Tested on Python 3.14
50+
51+
### Test Output
52+
53+
```bash
54+
# Paste test output here
55+
```
56+
57+
## Code Quality
58+
59+
<!-- Confirm code quality checks -->
60+
61+
- [ ] Ran `ruff check src/toon_format tests` - no issues
62+
- [ ] Ran `ruff format src/toon_format tests` - code formatted
63+
- [ ] Ran `mypy src/toon_format` - no critical errors
64+
- [ ] All tests pass: `pytest tests/ -v`
4965

5066
## Checklist
5167

5268
<!-- Mark completed items with an [x] -->
5369

54-
- [ ] My code follows the project's coding standards
70+
- [ ] My code follows the project's coding standards (PEP 8, line length 100)
5571
- [ ] I have added type hints to new code
56-
- [ ] I have run `ruff check` and `ruff format`
57-
- [ ] I have run `mypy` on my changes
5872
- [ ] I have added tests that prove my fix/feature works
5973
- [ ] New and existing tests pass locally
60-
- [ ] I have updated documentation (if needed)
74+
- [ ] I have updated documentation (README.md, CLAUDE.md if needed)
6175
- [ ] My changes do not introduce new dependencies
76+
- [ ] I have maintained Python 3.8+ compatibility
77+
- [ ] I have reviewed the [TOON specification](https://github.com/toon-format/spec) for relevant sections
78+
79+
## Performance Impact
80+
81+
<!-- If applicable, describe any performance implications -->
82+
83+
- [ ] No performance impact
84+
- [ ] Performance improvement (describe below)
85+
- [ ] Potential performance regression (describe and justify below)
86+
87+
<!-- Details: -->
88+
89+
## Breaking Changes
90+
91+
<!-- If this is a breaking change, describe the migration path for users -->
92+
93+
- [ ] No breaking changes
94+
- [ ] Breaking changes (describe migration path below)
95+
96+
<!-- Migration path: -->
97+
98+
## Screenshots / Examples
99+
100+
<!-- If applicable, add screenshots or example output -->
101+
102+
```python
103+
# Example usage
104+
```
105+
106+
Output:
107+
```
108+
# Example output
109+
```
62110

63111
## Additional Context
64112

65113
<!-- Add any other context about the PR here (optional) -->
114+
115+
## Checklist for Reviewers
116+
117+
<!-- For maintainers reviewing this PR -->
118+
119+
- [ ] Code changes are clear and well-documented
120+
- [ ] Tests adequately cover the changes
121+
- [ ] Documentation is updated
122+
- [ ] No security concerns
123+
- [ ] Follows TOON specification
124+
- [ ] Backward compatible (or breaking changes are justified and documented)

.github/workflows/publish.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ jobs:
4242
runs-on: ubuntu-latest
4343
environment:
4444
name: pypi
45-
url: https://pypi.org/p/toon-format
45+
url: https://pypi.org/p/python-toon
4646
permissions:
4747
id-token: write
4848

@@ -63,7 +63,7 @@ jobs:
6363
runs-on: ubuntu-latest
6464
environment:
6565
name: testpypi
66-
url: https://test.pypi.org/p/toon-format
66+
url: https://test.pypi.org/p/python-toon
6767
permissions:
6868
id-token: write
6969

README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@
33
A compact, human-readable serialization format designed for passing structured data to Large Language Models with significantly reduced token usage.
44

55
[![Tests](https://github.com/toon-format/toon-python/actions/workflows/test.yml/badge.svg)](https://github.com/toon-format/toon-python/actions)
6-
[![PyPI](https://img.shields.io/pypi/v/toon-format.svg)](https://pypi.org/project/toon-format/)
7-
[![Python Versions](https://img.shields.io/pypi/pyversions/toon-format.svg)](https://pypi.org/project/toon-format/)
6+
[![PyPI](https://img.shields.io/pypi/v/python-toon.svg)](https://pypi.org/project/python-toon/)
7+
[![Python Versions](https://img.shields.io/pypi/pyversions/python-toon.svg)](https://pypi.org/project/python-toon/)
88

99
## Installation
1010

1111
```bash
1212
# With pip
13-
pip install toon-format
13+
pip install python-toon
1414

1515
# With uv (recommended)
16-
uv pip install toon-format
16+
uv pip install python-toon
1717
```
1818

1919
## What is TOON?

examples.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
"""Examples demonstrating toon-format usage."""
1+
"""Examples demonstrating python-toon usage."""
22

33
from toon_format import encode
44

pyproject.toml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[project]
2-
name = "toon-format"
3-
version = "0.1.0"
2+
name = "python-toon"
3+
version = "1.0.0"
44
description = "A compact, human-readable serialization format designed for passing structured data to Large Language Models with significantly reduced token usage"
55
readme = "README.md"
66
authors = [
@@ -37,9 +37,9 @@ toon = "toon_format.cli:main"
3737
[dependency-groups]
3838
dev = [
3939
"pytest>=8.0.0",
40-
"pytest-cov>=6.0.0",
40+
"pytest-cov>=4.1.0",
4141
"ruff>=0.8.0",
42-
"mypy>=1.13.0",
42+
"mypy>=1.8.0",
4343
]
4444

4545
[tool.pytest.ini_options]

requirements-dev.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,6 @@
22
pytest>=8.0.0
33
pytest-cov>=4.1.0
44
mypy>=1.8.0
5-
ruff>=0.1.0
5+
ruff>=0.8.0
66
build>=1.0.0
77
twine>=5.0.0

0 commit comments

Comments
 (0)