Skip to content

Commit

Permalink
ver 0.1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
hajimen committed Jan 17, 2025
1 parent 46d66c0 commit 35079c7
Show file tree
Hide file tree
Showing 6 changed files with 43 additions and 23 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -139,3 +139,4 @@ dmypy.json
cython_debug/

.vscode
venv*
28 changes: 18 additions & 10 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,31 @@
# Changelog

## Initial Release: Version 0.0.1 : 2020/12/16
## [0.1.1] - 2025-01-17

Ported from [commit #4080386 on Dec 31, 2019](https://github.com/ijprest/kle-serial/commit/4080386fcdcb66a391e1b4857532512f9ca4121e).
- Now Python 3.13 ready (No code change, just tested).
- Project name slightly changed from "pykle_serial" to "pykle-serial". Looks better in PyPI.
- CHANGELOG style changed.
- Now Development Status :: 4 - Beta

## Release: Version 0.0.2 : 2021/5/22
## [0.0.5] - 2023-07-12

pykle_serial.serial has been renamed to pykle_serial.
setup.cfg error has been fixed.
Now Python 3.11 ready. Drops 3.7 support. (but it still works I guess)

## [0.0.4] - 2023-05-11

Bug fix: Blank profile '' was ignored.

## Release: Version 0.0.3 : 2021/6/18
## [0.0.3] - 2021-06-18

[Fix issue with incorrect x and y for rotated key](https://github.com/ijprest/kle-serial/pull/1/commits/913a6f42f3ee03586d1cb0665f5d24ffe5bf5b68)
is ported from [commit #913a6f4 on Aug 19, 2019](https://github.com/kevin-wells/kle-serial/commit/913a6f42f3ee03586d1cb0665f5d24ffe5bf5b68).

## Release: Version 0.0.4 : 2023/5/11
## [0.0.2] - 2021-05-22

Bug fix: Blank profile '' was ignored.
pykle_serial.serial has been renamed to pykle_serial.
setup.cfg error has been fixed.

## Release: Version 0.0.5 : 2023/7/12
## [0.0.1] - 2020-12-16

Now Python 3.11 ready. Drops 3.7 support. (but it still works I guess)
Initial Release.
Ported from [commit #4080386 on Dec 31, 2019](https://github.com/ijprest/kle-serial/commit/4080386fcdcb66a391e1b4857532512f9ca4121e).
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2020 NAKAZATO Hajime
Copyright (c) 2020-2025 NAKAZATO Hajime

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
# pykle_serial
# pykle-serial

pykle_serial is a Python library for parsing the serialized format used on [keyboard-layout-editor.com (KLE)](http://www.keyboard-layout-editor.com/).
pykle_serial is a Python port of [kle-serial](https://github.com/ijprest/kle-serial),
**pykle-serial** is a Python library for parsing the serialized format used on [keyboard-layout-editor.com (KLE)](http://www.keyboard-layout-editor.com/).

pykle-serial is a Python port of [kle-serial](https://github.com/ijprest/kle-serial),
based on [commit #4080386 on Dec 31, 2019](https://github.com/ijprest/kle-serial/commit/4080386fcdcb66a391e1b4857532512f9ca4121e)
and includes [Fix issue with incorrect x and y for rotated key](https://github.com/ijprest/kle-serial/pull/1/commits/913a6f42f3ee03586d1cb0665f5d24ffe5bf5b68).

## Usage

```
```python
import pykle_serial as kle_serial

keyboard = kle_serial.deserialize([
Expand Down Expand Up @@ -40,3 +41,7 @@ JavaScript doesn't distinguish between float and int. Python does.
- KLE's "Raw data" text requires additional outer `[]` as JSON5.

- `labels` is HTML fragment.

## License

MIT license.
2 changes: 1 addition & 1 deletion pykle_serial/__init__.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from .serial import Key, Keyboard, KeyboardMetadata, deserialize, parse, UB_LABEL_MAP

__version_info__ = (0, 0, 5)
__version_info__ = (0, 1, 1)
__version__ = '.'.join(map(str, __version_info__))
20 changes: 13 additions & 7 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,32 +3,38 @@ requires = ["setuptools"]
build-backend = "setuptools.build_meta"

[project]
name = "pykle_serial"
name = "pykle-serial"
dynamic = ["version"]
description = "A Python library for parsing the serialized format used on keyboard-layout-editor.com (KLE)."
authors = [{name = "Hajime Nakazato", email = "[email protected]"},
]
license ={text = "MIT License"}
readme = "README.md"
requires-python = ">=3.8"
authors = [{name = "Hajime Nakazato", email = "[email protected]"}]
readme = "README.md"
license = {file = "LICENSE"}
keywords = ["keyboard-layout-editor", "KLE"]
classifiers = [
"Development Status :: 3 - Alpha",
"Development Status :: 4 - Beta",
"Intended Audience :: Developers",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"Topic :: Software Development :: Libraries :: Python Modules",
]
dependencies = [
"json5 >= 0.9.5",
]

[project.urls]
Bug_Tracker = "https://github.com/hajimen/pykle_serial/issues"
Repository = "https://github.com/hajimen/pykle_serial.git"
"Bug Tracker" = "https://github.com/hajimen/pykle_serial/issues"
Changelog = "https://github.com/hajimen/pykle_serial/blob/master/CHANGELOG.md"

[tool.setuptools.dynamic]
version = {attr = "pykle_serial.__version__"}

[tool.setuptools.package-dir]
"pykle_serial" = "pykle_serial"

0 comments on commit 35079c7

Please sign in to comment.