pixel-font-knife 0.0.1__tar.gz

pixel_font_knife-0.0.1/.github/workflows/publish.yml

@@ -0,0 +1,29 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/pixel-font-knife/
+    permissions:
+      id-token: write
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Setup Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.x"
+    - name: Install dependencies
+      run: |
+        python -m pip install pip --upgrade
+        python -m pip install build
+    - name: Build
+      run: python -m build
+    - name: Publish
+      uses: pypa/gh-action-pypi-publish@release/v1

pixel_font_knife-0.0.1/.github/workflows/test.yml

@@ -0,0 +1,24 @@
+name: Test
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Setup Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install pip --upgrade
+        python -m pip install -r requirements.txt
+    - name: Test
+      run: python -m pytest

pixel_font_knife-0.0.1/.gitignore

@@ -0,0 +1,141 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+.idea/

pixel_font_knife-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 TakWolf
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

pixel_font_knife-0.0.1/PKG-INFO

@@ -0,0 +1,41 @@
+Metadata-Version: 2.3
+Name: pixel-font-knife
+Version: 0.0.1
+Summary: A set of pixel font utilities.
+Project-URL: homepage, https://github.com/TakWolf/pixel-font-knife
+Project-URL: source, https://github.com/TakWolf/pixel-font-knife
+Project-URL: issues, https://github.com/TakWolf/pixel-font-knife/issues
+Author: TakWolf
+Maintainer: TakWolf
+License: MIT License
+License-File: LICENSE
+Keywords: font,pixel
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: pypng>=0.20220715.0
+Description-Content-Type: text/markdown
+
+# Pixel Font Knife
+
+[![Python](https://img.shields.io/badge/python-3.10-brightgreen)](https://www.python.org)
+[![PyPI](https://img.shields.io/pypi/v/pixel-font-knife)](https://pypi.org/project/pixel-font-knife/)
+
+一组像素字体实用工具。
+
+该库被设计用于和 [Pixel Font Builder](https://github.com/TakWolf/pixel-font-builder) 配合使用，也包含一些符合 [Ark Pixel Font](https://github.com/TakWolf/ark-pixel-font) 构建约定的通用工具。
+
+## 安装
+
+```shell
+pip install pixel-font-knife
+```
+
+## 程序依赖
+
+- [PyPNG](https://gitlab.com/drj11/pypng)
+
+## 许可证
+
+基于 [MIT 许可证](LICENSE)。

pixel_font_knife-0.0.1/README.md

@@ -0,0 +1,22 @@
+# Pixel Font Knife
+
+[![Python](https://img.shields.io/badge/python-3.10-brightgreen)](https://www.python.org)
+[![PyPI](https://img.shields.io/pypi/v/pixel-font-knife)](https://pypi.org/project/pixel-font-knife/)
+
+一组像素字体实用工具。
+
+该库被设计用于和 [Pixel Font Builder](https://github.com/TakWolf/pixel-font-builder) 配合使用，也包含一些符合 [Ark Pixel Font](https://github.com/TakWolf/ark-pixel-font) 构建约定的通用工具。
+
+## 安装
+
+```shell
+pip install pixel-font-knife
+```
+
+## 程序依赖
+
+- [PyPNG](https://gitlab.com/drj11/pypng)
+
+## 许可证
+
+基于 [MIT 许可证](LICENSE)。

pixel_font_knife-0.0.1/pyproject.toml

@@ -0,0 +1,41 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pixel-font-knife"
+version = "0.0.1"
+description = "A set of pixel font utilities."
+readme = "README.md"
+license = { text = "MIT License" }
+requires-python = ">=3.10"
+authors = [
+    { name = "TakWolf" },
+]
+maintainers = [
+    { name = "TakWolf" },
+]
+keywords = ["font", "pixel"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+dependencies = [
+    "pypng>=0.20220715.0",
+]
+
+[project.urls]
+homepage = "https://github.com/TakWolf/pixel-font-knife"
+source = "https://github.com/TakWolf/pixel-font-knife"
+issues = "https://github.com/TakWolf/pixel-font-knife/issues"
+
+[tool.pytest.ini_options]
+pythonpath = [
+    ".",
+    "src",
+]
+addopts = [
+    "--import-mode=importlib",
+]

pixel_font_knife-0.0.1/requirements.txt

@@ -0,0 +1,3 @@
+pypng==0.20220715.0
+
+pytest==8.2.2

pixel_font_knife-0.0.1/src/pixel_font_knife/mono_bitmap_util.py

@@ -0,0 +1,35 @@
+from os import PathLike
+
+import png
+
+
+def load_png(
+        file_path: str | bytes | PathLike[str] | PathLike[bytes],
+) -> tuple[list[list[int]], int, int]:
+    width, height, pixels, _ = png.Reader(filename=file_path).read()
+    bitmap = []
+    for pixels_row in pixels:
+        bitmap_row = []
+        for i in range(0, width * 4, 4):
+            alpha = pixels_row[i + 3]
+            bitmap_row.append(1 if alpha > 127 else 0)
+        bitmap.append(bitmap_row)
+    return bitmap, width, height
+
+
+def save_png(
+        bitmap: list[list[int]],
+        file_path: str | bytes | PathLike[str] | PathLike[bytes],
+        color: tuple[int, int, int] = (0, 0, 0),
+):
+    red, green, blue = color
+    pixels = []
+    for bitmap_row in bitmap:
+        pixels_row = []
+        for alpha in bitmap_row:
+            pixels_row.append(red)
+            pixels_row.append(green)
+            pixels_row.append(blue)
+            pixels_row.append(255 if alpha != 0 else 0)
+        pixels.append(pixels_row)
+    png.from_array(pixels, 'RGBA').save(file_path)

pixel_font_knife-0.0.1/tests/conftest.py

@@ -0,0 +1,13 @@
+from pathlib import Path
+
+import pytest
+
+
+@pytest.fixture(scope='session')
+def project_root_dir() -> Path:
+    return Path(__file__).parent.joinpath('..').resolve()
+
+
+@pytest.fixture(scope='session')
+def assets_dir(project_root_dir: Path) -> Path:
+    return project_root_dir.joinpath('assets')

pixel_font_knife-0.0.1/tests/test_mono_bitmap_util.py

@@ -0,0 +1,39 @@
+import hashlib
+from pathlib import Path
+
+from pixel_font_knife import mono_bitmap_util
+
+
+def _file_sha256(file_path: Path) -> str:
+    return hashlib.sha256(file_path.read_bytes()).hexdigest()
+
+
+def test_load_save(assets_dir: Path, tmp_path: Path):
+    black_load_path = assets_dir.joinpath('png', '4E2D-black.png')
+    black_save_path = tmp_path.joinpath('4E2D-black.png')
+    black_bitmap, black_width, black_height = mono_bitmap_util.load_png(black_load_path)
+    mono_bitmap_util.save_png(black_bitmap, black_save_path)
+
+    red_load_path = assets_dir.joinpath('png', '4E2D-red.png')
+    red_save_path = tmp_path.joinpath('4E2D-red.png')
+    red_bitmap, red_width, red_height = mono_bitmap_util.load_png(red_load_path)
+    mono_bitmap_util.save_png(red_bitmap, red_save_path, color=(255, 0, 0))
+
+    assert black_bitmap == red_bitmap == [
+        [0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0],
+        [0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0],
+        [0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0],
+        [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0],
+        [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0],
+        [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0],
+        [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0],
+        [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0],
+        [0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0],
+        [0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0],
+        [0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0],
+        [0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0]
+    ]
+    assert black_width == red_width == 12
+    assert black_height == red_height == 12
+    assert _file_sha256(black_load_path) == _file_sha256(black_save_path)
+    assert _file_sha256(red_load_path) == _file_sha256(red_save_path)