foundrytools-cli 1.1.22__tar.gz → 2.0.1__tar.gz

foundrytools_cli-2.0.1/.gitignore

@@ -0,0 +1,161 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+foundryToolsCLI_2/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
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__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
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+.qodo

foundrytools_cli-2.0.1/PKG-INFO

@@ -0,0 +1,115 @@
+Metadata-Version: 2.4
+Name: foundrytools-cli
+Version: 2.0.1
+Summary: A set of command line tools to inspect, manipulate and convert font files
+Project-URL: Homepage, https://github.com/ftCLI/FoundryTools-CLI
+Author-email: Cesare Gilento <ftcli@proton.me>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Text Processing :: Fonts
+Requires-Python: >=3.9
+Requires-Dist: afdko>=4.0.2
+Requires-Dist: click>=8.1.8
+Requires-Dist: foundrytools>=0.1.4
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: pathvalidate>=3.2.3
+Requires-Dist: rich>=14.0.0
+Requires-Dist: win32-setctime>=1.2.0; sys_platform >= 'win32'
+Provides-Extra: dev
+Requires-Dist: bump-my-version>=1.1.2; extra == 'dev'
+Requires-Dist: hatch>=1.14.1; extra == 'dev'
+Requires-Dist: mypy>=1.15.0; extra == 'dev'
+Requires-Dist: pre-commit>=4.2.0; extra == 'dev'
+Requires-Dist: pylint>=3.3.6; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: sphinx-click>=6.0.0; extra == 'docs'
+Requires-Dist: sphinx-rtd-theme>=3.0.2; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# FoundryTools-CLI
+
+FoundryTools-CLI is a command line interface for the
+[FoundryTools](https://github.com/ftCLI/FoundryTools) library, which provides a set of tools for
+working with font files. It is designed to be used from the command line, allowing users to perform
+various operations on font files without the need for a graphical user interface.
+
+The CLI provides a range of commands for manipulating font files, including converting between
+different font formats, extracting and modifying font metadata, and performing various font-related
+operations. It is built on top of the FoundryTools library, which provides a comprehensive set of
+tools for working with font files in Python.
+
+The CLI is designed to be easy to use and provides a consistent interface for working with different
+font formats. It is suitable for both developers and font designers who need to perform various
+operations on font files from the command line. The CLI is also extensible, allowing users to add
+their own commands and functionality as needed.
+
+![image](https://github.com/user-attachments/assets/f1389440-8b94-463f-b9c8-29c0c37dfced)
+
+The command line interface is built with [click](https://github.com/pallets/click/) and tables are
+rendered by [rich](https://github.com/Textualize/rich).
+
+## Installation
+
+FoundryTools-CLI requires Python 3.9 or later.
+
+**IMPORTANT**: If you have Python 2.x installed in your system, you may have to use `python3`
+(instead of `python`) in the commands below.
+
+### pip
+
+FoundryTools-CLI releases are available on the Python Package Index (PyPI), so it can be installed
+with [pip](https://pip.pypa.io/):
+
+```
+python -m pip install foundrytools-cli
+```
+
+### Editable mode
+
+If you would like to contribute to the development, you can clone the repository from GitHub,
+install the package in 'editable' mode and modify the source code in place. We strongly recommend
+using a virtual environment.
+
+```
+# clone the repository:
+git clone https://github.com/ftCLI/foundrytools-cli.git
+cd foundrytools-cli
+
+# create new virtual environment named e.g. ftcli-venv, or whatever you prefer:
+python -m venv ftcli-venv
+
+# to activate the virtual environmtnet in macOS and Linux, do:
+. ftcli-venv/bin/activate
+
+# to activate the virtual environment in Windows, do:
+ftcli-venv\Scripts\activate.bat
+
+# install in 'editable' mode
+python -m pip install -e .
+```
+
+## Documentation
+
+FoundryTools-CLI is a Terminal app where commands are logically organized into subcommands.
+
+Please refer to the [user documentation](https://foundrytools-cli.readthedocs.io/).
+
+## License
+
+FoundryTools-CLI is available under the [MIT license](LICENSE)
+
+## Credits
+
+To Sergiev. May You rest in peace.

foundrytools_cli-2.0.1/README.md

@@ -0,0 +1,75 @@
+# FoundryTools-CLI
+
+FoundryTools-CLI is a command line interface for the
+[FoundryTools](https://github.com/ftCLI/FoundryTools) library, which provides a set of tools for
+working with font files. It is designed to be used from the command line, allowing users to perform
+various operations on font files without the need for a graphical user interface.
+
+The CLI provides a range of commands for manipulating font files, including converting between
+different font formats, extracting and modifying font metadata, and performing various font-related
+operations. It is built on top of the FoundryTools library, which provides a comprehensive set of
+tools for working with font files in Python.
+
+The CLI is designed to be easy to use and provides a consistent interface for working with different
+font formats. It is suitable for both developers and font designers who need to perform various
+operations on font files from the command line. The CLI is also extensible, allowing users to add
+their own commands and functionality as needed.
+
+![image](https://github.com/user-attachments/assets/f1389440-8b94-463f-b9c8-29c0c37dfced)
+
+The command line interface is built with [click](https://github.com/pallets/click/) and tables are
+rendered by [rich](https://github.com/Textualize/rich).
+
+## Installation
+
+FoundryTools-CLI requires Python 3.9 or later.
+
+**IMPORTANT**: If you have Python 2.x installed in your system, you may have to use `python3`
+(instead of `python`) in the commands below.
+
+### pip
+
+FoundryTools-CLI releases are available on the Python Package Index (PyPI), so it can be installed
+with [pip](https://pip.pypa.io/):
+
+```
+python -m pip install foundrytools-cli
+```
+
+### Editable mode
+
+If you would like to contribute to the development, you can clone the repository from GitHub,
+install the package in 'editable' mode and modify the source code in place. We strongly recommend
+using a virtual environment.
+
+```
+# clone the repository:
+git clone https://github.com/ftCLI/foundrytools-cli.git
+cd foundrytools-cli
+
+# create new virtual environment named e.g. ftcli-venv, or whatever you prefer:
+python -m venv ftcli-venv
+
+# to activate the virtual environmtnet in macOS and Linux, do:
+. ftcli-venv/bin/activate
+
+# to activate the virtual environment in Windows, do:
+ftcli-venv\Scripts\activate.bat
+
+# install in 'editable' mode
+python -m pip install -e .
+```
+
+## Documentation
+
+FoundryTools-CLI is a Terminal app where commands are logically organized into subcommands.
+
+Please refer to the [user documentation](https://foundrytools-cli.readthedocs.io/).
+
+## License
+
+FoundryTools-CLI is available under the [MIT license](LICENSE)
+
+## Credits
+
+To Sergiev. May You rest in peace.

foundrytools_cli-2.0.1/pyproject.toml

@@ -0,0 +1,86 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "foundrytools-cli"
+dynamic = ["version"]
+description = "A set of command line tools to inspect, manipulate and convert font files"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.9"
+authors = [
+    { name = "Cesare Gilento", email = "ftcli@proton.me" },
+]
+
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Intended Audience :: End Users/Desktop",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "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",
+    "License :: OSI Approved :: MIT License",
+    "Topic :: Text Processing :: Fonts",
+]
+
+dependencies = [
+    "afdko>=4.0.2",
+    "click>=8.1.8",
+    "foundrytools>=0.1.4",
+    "loguru>=0.7.3",
+    "pathvalidate>=3.2.3",
+    "rich>=14.0.0",
+    "win32-setctime>=1.2.0; sys_platform >= 'win32'",
+]
+
+[project.scripts]
+ftcli = "foundrytools_cli.__main__:cli"
+
+[project.urls]
+Homepage = "https://github.com/ftCLI/FoundryTools-CLI"
+
+[project.optional-dependencies]
+dev = [
+    "bump-my-version>=1.1.2",
+    "hatch>=1.14.1",
+    "mypy>=1.15.0",
+    "pre-commit>=4.2.0",
+    "pylint>=3.3.6",
+]
+docs = [
+    "sphinx-click>=6.0.0",
+    "sphinx-rtd-theme>=3.0.2",
+]
+
+[tool.hatch.version]
+path = "src/foundrytools_cli/__init__.py"
+pattern = 'VERSION = __version__ = "(?P<version>[^"]+)"'
+
+[tool.hatch.build.targets.sdist]
+include = [
+    "/src",
+]
+exclude = [
+    "/.gitignore",
+]
+
+[tool.bumpversion]
+current_version = "2.0.1"
+commit = true
+tag = true
+
+[[tool.bumpversion.files]]
+filename = "src/foundrytools_cli/__init__.py"
+search = '__version__ = "{current_version}"'
+replace = '__version__ = "{new_version}"'
+
+[[tool.bumpversion.files]]
+filename = "docs/source/conf.py"
+search = 'release = "{current_version}"'
+replace = 'release = "{new_version}"'

foundrytools_cli-2.0.1/src/foundrytools_cli/__init__.py

@@ -0,0 +1,3 @@
+VERSION = __version__ = "2.0.1"
+
+__all__ = ["VERSION"]

foundrytools_cli-2.0.1/src/foundrytools_cli/__main__.py

@@ -0,0 +1,40 @@
+import click
+
+from foundrytools_cli.commands.cff import cli as cff
+from foundrytools_cli.commands.cmap import cli as cmap
+from foundrytools_cli.commands.converter import cli as converter
+from foundrytools_cli.commands.fix import cli as fix
+from foundrytools_cli.commands.font import cli as font
+from foundrytools_cli.commands.gsub import cli as gsub
+from foundrytools_cli.commands.hhea import cli as hhea
+from foundrytools_cli.commands.name import cli as name
+from foundrytools_cli.commands.os_2 import cli as os_2
+from foundrytools_cli.commands.otf import cli as otf
+from foundrytools_cli.commands.post import cli as post
+from foundrytools_cli.commands.print import cli as print_
+from foundrytools_cli.commands.ttf import cli as ttf
+from foundrytools_cli.commands.utils import cli as utils
+
+
+@click.group(
+    help="A collection of command line tools for working with font files.",
+    commands={
+        "cff": cff,
+        "cmap": cmap,
+        "converter": converter,
+        "fix": fix,
+        "font": font,
+        "gsub": gsub,
+        "hhea": hhea,
+        "name": name,
+        "os2": os_2,
+        "otf": otf,
+        "post": post,
+        "print": print_,
+        "ttf": ttf,
+        "utils": utils,
+    },
+)
+@click.version_option()
+def cli() -> None:  # pylint: disable=missing-function-docstring
+    pass

foundrytools_cli-2.0.1/src/foundrytools_cli/commands/cff.py

@@ -0,0 +1,124 @@
+from pathlib import Path
+from typing import Any, Callable
+
+import click
+from foundrytools import Font
+from foundrytools.constants import TOP_DICT_NAMES
+
+from foundrytools_cli.utils import BaseCommand, ensure_at_least_one_param, make_options
+from foundrytools_cli.utils.task_runner import TaskRunner
+
+
+def _top_dict_names_flags() -> Callable:
+    flags = [
+        click.option(
+            f"--{option_param}",
+            var_name,
+            is_flag=True,
+            default=None,
+            help=f"Deletes the ``{var_name}`` value",
+        )
+        for option_param, var_name in sorted(TOP_DICT_NAMES.items())
+    ]
+
+    return make_options(flags)
+
+
+def _top_dict_names_options() -> Callable:
+    options = [
+        click.option(
+            f"--{option_param}",
+            var_name,
+            type=str,
+            help=f"Sets the ``cff.topDictIndex[0].{var_name}`` value",
+        )
+        for option_param, var_name in sorted(TOP_DICT_NAMES.items())
+    ]
+
+    return make_options(options)
+
+
+cli = click.Group("cff", help="Utilities for editing the ``CFF`` table.")
+
+
+@cli.command("set-names", cls=BaseCommand)
+@click.option(
+    "--font-name",
+    "fontNames",
+    type=str,
+    help="Sets the ``cff.fontNames`` value",
+)
+@_top_dict_names_options()
+def set_names(input_path: Path, **options: dict[str, Any]) -> None:
+    """
+    Sets the ``cff.fontNames[0]`` and/or ``topDictIndex[0]`` values.
+    """
+    ensure_at_least_one_param(click.get_current_context())
+
+    def task(font: Font, **kwargs: dict[str, str]) -> bool:
+        font.t_cff_.set_names(**kwargs)
+        return True
+
+    runner = TaskRunner(input_path=input_path, task=task, **options)
+    runner.filter.filter_out_tt = True
+    runner.run()
+
+
+@cli.command("del-names", cls=BaseCommand)
+@_top_dict_names_flags()
+@click.option(
+    "--unique-id",
+    "UniqueID",
+    is_flag=True,
+    default=None,
+    help="Deletes the ``UniqueID`` value",
+)
+def del_names(input_path: Path, **options: dict[str, Any]) -> None:
+    """
+    Deletes attributes from ``topDictIndex[0]`` using the provided keyword arguments.
+    """
+    ensure_at_least_one_param(click.get_current_context())
+
+    def task(font: Font, **kwargs: dict[str, str]) -> bool:
+        font.t_cff_.del_names(**kwargs)
+        return True
+
+    runner = TaskRunner(input_path=input_path, task=task, **options)
+    runner.filter.filter_out_tt = True
+    runner.run()
+
+
+@cli.command("find-replace", cls=BaseCommand)
+@click.option(
+    "-os",
+    "--old-string",
+    required=True,
+    help="The string to be replaced in th CFF TopDictIndex[0] fields.",
+)
+@click.option(
+    "-ns",
+    "--new-string",
+    required=True,
+    help="The string to replace the old string with in the CFF TopDictIndex[0] fields.",
+)
+def find_replace(input_path: Path, **options: dict[str, Any]) -> None:
+    """
+    Finds and replaces a string in the ``CFF`` table. It performs the replacement in
+    ``cff.fontNames[0]`` and in the following ``topDictIndex[0]`` fields:
+
+    \b
+    * version
+    * FullName
+    * FamilyName
+    * Weight
+    * Copyright
+    * Notice
+    """
+
+    def task(font: Font, old_string: str, new_string: str) -> bool:
+        font.t_cff_.find_replace(old_string, new_string)
+        return True
+
+    runner = TaskRunner(input_path=input_path, task=task, **options)
+    runner.filter.filter_out_tt = True
+    runner.run()

foundrytools_cli-2.0.1/src/foundrytools_cli/commands/cmap.py

@@ -0,0 +1,39 @@
+from pathlib import Path
+from typing import Any
+
+import click
+from foundrytools import Font
+
+from foundrytools_cli.utils import BaseCommand
+from foundrytools_cli.utils.logger import logger
+from foundrytools_cli.utils.task_runner import TaskRunner
+
+cli = click.Group(help="Utilities for editing the ``cmap`` table.")
+
+
+@cli.command("rebuild", cls=BaseCommand)
+@click.option(
+    "--remap-all",
+    is_flag=True,
+    help="Remap all glyphs, including the ones already in the cmap table.",
+)
+def rebuild_cmap(input_path: Path, **options: dict[str, Any]) -> None:
+    """
+    Rebuild the cmap table of a font. Optionally remap all characters, including those already in
+    the cmap table.
+    """
+
+    def task(font: Font, remap_all: bool = False) -> bool:
+        remapped_glyphs, _ = font.t_cmap.rebuild_character_map(remap_all=remap_all)
+        if remapped_glyphs:
+            logger.info("Remapped glyphs:")
+            for r in remapped_glyphs:
+                logger.opt(colors=True).info(
+                    f" {r[1]} -> <lc>{hex(r[0])[:2]}{hex(r[0])[2:].upper().zfill(6)}</lc>"
+                )
+            return True
+
+        return False
+
+    runner = TaskRunner(input_path=input_path, task=task, **options)
+    runner.run()

foundrytools_cli-2.0.1/src/foundrytools_cli/commands/converter/__init__.py

@@ -0,0 +1,3 @@
+from foundrytools_cli.commands.converter.cli import cli
+
+__all__ = ["cli"]