pcffont 0.0.1__tar.gz

pcffont-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/pcffont/
+    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

pcffont-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.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

pcffont-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/

pcffont-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.

pcffont-0.0.1/PKG-INFO

@@ -0,0 +1,76 @@
+Metadata-Version: 2.3
+Name: pcffont
+Version: 0.0.1
+Summary: A library for manipulating Portable Compiled Format (PCF) Fonts.
+Project-URL: homepage, https://github.com/TakWolf/pcffont
+Project-URL: source, https://github.com/TakWolf/pcffont
+Project-URL: issues, https://github.com/TakWolf/pcffont/issues
+Author: TakWolf
+Maintainer: TakWolf
+License: MIT License
+License-File: LICENSE
+Keywords: font,pcf
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# PcfFont
+
+[![Python](https://img.shields.io/badge/python-3.11-brightgreen)](https://www.python.org)
+[![PyPI](https://img.shields.io/pypi/v/pcffont)](https://pypi.org/project/pcffont/)
+
+PcfFont is a library for manipulating [Portable Compiled Format (PCF) Fonts](https://en.wikipedia.org/wiki/Portable_Compiled_Format).
+
+## Installation
+
+```shell
+pip install pcffont
+```
+
+## Usage
+
+```python
+import os
+import shutil
+
+from examples import assets_dir, build_dir
+from pcffont import PcfFont
+
+
+def main():
+    outputs_dir = os.path.join(build_dir, 'demo')
+    if os.path.exists(outputs_dir):
+        shutil.rmtree(outputs_dir)
+    os.makedirs(outputs_dir)
+
+    font = PcfFont.load(os.path.join(assets_dir, 'unifont', 'unifont-15.1.05.pcf'))
+    print(f'name: {font.properties.font}')
+    print(f'size: {font.properties.pixel_size}')
+    print(f'ascent: {font.accelerators.font_ascent}')
+    print(f'descent: {font.accelerators.font_descent}')
+    for code_point, glyph_index in sorted(font.bdf_encodings.items()):
+        print(f'{code_point:04X} {chr(code_point)} - {font.glyph_names[glyph_index]}')
+        for bitmap_row in font.bitmaps[glyph_index]:
+            print(''.join(map(str, bitmap_row)).replace('0', '__').replace('1', '**'))
+        print()
+    font.save(os.path.join(outputs_dir, 'unifont-15.1.05.pcf'))
+
+
+if __name__ == '__main__':
+    main()
+```
+
+## Test Fonts
+
+- [GNU Unifont Glyphs](https://unifoundry.com/unifont/index.html)
+- [bitmap-fonts](https://github.com/masaeedu/bitmap-fonts)
+
+## References
+
+- [FontForge - The X11 PCF bitmap font file format](https://fontforge.org/docs/techref/pcf-format.html)
+
+## License
+
+Under the [MIT license](LICENSE).

pcffont-0.0.1/README.md

@@ -0,0 +1,58 @@
+# PcfFont
+
+[![Python](https://img.shields.io/badge/python-3.11-brightgreen)](https://www.python.org)
+[![PyPI](https://img.shields.io/pypi/v/pcffont)](https://pypi.org/project/pcffont/)
+
+PcfFont is a library for manipulating [Portable Compiled Format (PCF) Fonts](https://en.wikipedia.org/wiki/Portable_Compiled_Format).
+
+## Installation
+
+```shell
+pip install pcffont
+```
+
+## Usage
+
+```python
+import os
+import shutil
+
+from examples import assets_dir, build_dir
+from pcffont import PcfFont
+
+
+def main():
+    outputs_dir = os.path.join(build_dir, 'demo')
+    if os.path.exists(outputs_dir):
+        shutil.rmtree(outputs_dir)
+    os.makedirs(outputs_dir)
+
+    font = PcfFont.load(os.path.join(assets_dir, 'unifont', 'unifont-15.1.05.pcf'))
+    print(f'name: {font.properties.font}')
+    print(f'size: {font.properties.pixel_size}')
+    print(f'ascent: {font.accelerators.font_ascent}')
+    print(f'descent: {font.accelerators.font_descent}')
+    for code_point, glyph_index in sorted(font.bdf_encodings.items()):
+        print(f'{code_point:04X} {chr(code_point)} - {font.glyph_names[glyph_index]}')
+        for bitmap_row in font.bitmaps[glyph_index]:
+            print(''.join(map(str, bitmap_row)).replace('0', '__').replace('1', '**'))
+        print()
+    font.save(os.path.join(outputs_dir, 'unifont-15.1.05.pcf'))
+
+
+if __name__ == '__main__':
+    main()
+```
+
+## Test Fonts
+
+- [GNU Unifont Glyphs](https://unifoundry.com/unifont/index.html)
+- [bitmap-fonts](https://github.com/masaeedu/bitmap-fonts)
+
+## References
+
+- [FontForge - The X11 PCF bitmap font file format](https://fontforge.org/docs/techref/pcf-format.html)
+
+## License
+
+Under the [MIT license](LICENSE).

pcffont-0.0.1/assets/unifont/OFL.txt

@@ -0,0 +1,90 @@
+The SIL Open Font License version 1.1 is copied below, and is also
+available with a FAQ at http://scripts.sil.org/OFL.
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

pcffont-0.0.1/examples/__init__.py

@@ -0,0 +1,5 @@
+import os
+
+project_root_dir = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
+assets_dir = os.path.join(project_root_dir, 'assets')
+build_dir = os.path.join(project_root_dir, 'build')

pcffont-0.0.1/examples/demo.py

@@ -0,0 +1,28 @@
+import os
+import shutil
+
+from examples import assets_dir, build_dir
+from pcffont import PcfFont
+
+
+def main():
+    outputs_dir = os.path.join(build_dir, 'demo')
+    if os.path.exists(outputs_dir):
+        shutil.rmtree(outputs_dir)
+    os.makedirs(outputs_dir)
+
+    font = PcfFont.load(os.path.join(assets_dir, 'unifont', 'unifont-15.1.05.pcf'))
+    print(f'name: {font.properties.font}')
+    print(f'size: {font.properties.pixel_size}')
+    print(f'ascent: {font.accelerators.font_ascent}')
+    print(f'descent: {font.accelerators.font_descent}')
+    for code_point, glyph_index in sorted(font.bdf_encodings.items()):
+        print(f'{code_point:04X} {chr(code_point)} - {font.glyph_names[glyph_index]}')
+        for bitmap_row in font.bitmaps[glyph_index]:
+            print(''.join(map(str, bitmap_row)).replace('0', '__').replace('1', '**'))
+        print()
+    font.save(os.path.join(outputs_dir, 'unifont-15.1.05.pcf'))
+
+
+if __name__ == '__main__':
+    main()

pcffont-0.0.1/pyproject.toml

@@ -0,0 +1,34 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pcffont"
+version = "0.0.1"
+description = "A library for manipulating Portable Compiled Format (PCF) Fonts."
+readme = "README.md"
+license = { text = "MIT License" }
+requires-python = ">=3.11"
+authors = [
+    { name = "TakWolf" },
+]
+maintainers = [
+    { name = "TakWolf" },
+]
+keywords = ["pcf", "font"]
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+
+[project.urls]
+homepage = "https://github.com/TakWolf/pcffont"
+source = "https://github.com/TakWolf/pcffont"
+issues = "https://github.com/TakWolf/pcffont/issues"
+
+[tool.pytest.ini_options]
+pythonpath = "src"
+addopts = [
+    "--import-mode=importlib",
+]

pcffont-0.0.1/requirements.txt

@@ -0,0 +1 @@
+pytest==8.1.1

pcffont-0.0.1/src/pcffont/__init__.py

@@ -0,0 +1,10 @@
+from pcffont.font import PcfFont
+from pcffont.header import PcfTableType
+from pcffont.metric import PcfMetric
+from pcffont.t_properties import PcfProperties
+from pcffont.t_accelerators import PcfAccelerators
+from pcffont.t_metrics import PcfMetrics
+from pcffont.t_bitmaps import PcfBitmaps
+from pcffont.t_encodings import PcfBdfEncodings
+from pcffont.t_scalable_widths import PcfScalableWidths
+from pcffont.t_glyph_names import PcfGlyphNames

pcffont-0.0.1/src/pcffont/error.py

@@ -0,0 +1,25 @@
+
+class PcfError(Exception):
+    pass
+
+
+class PcfPropKeyError(PcfError):
+    def __init__(self, key: str, reason: str):
+        self.key = key
+        self.reason = reason
+        super().__init__(f"'{key}': {reason}")
+
+
+class PcfPropValueError(PcfError):
+    def __init__(self, key: str, value: object, reason: str):
+        self.key = key
+        self.value = value
+        self.reason = reason
+        super().__init__(f"'{key}': '{value}': {reason}")
+
+
+class PcfXlfdError(PcfError):
+    def __init__(self, font_name: str, reason: str):
+        self.font_name = font_name
+        self.reason = reason
+        super().__init__(f"'{font_name}': {reason}")