https://github.com/ftCLI/FoundryTools-CLI

A collection of command line tools to inspect, manipulate and convert font files
https://github.com/ftCLI/FoundryTools-CLI

Last synced: 4 months ago
JSON representation

A collection of command line tools to inspect, manipulate and convert font files

• Host: GitHub
• URL: https://github.com/ftCLI/FoundryTools-CLI
• Owner: ftCLI
• License: mit
• Created: 2021-04-29T14:10:31.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-12-19T06:58:46.000Z (about 1 year ago)
• Last Synced: 2023-12-19T10:19:24.250Z (about 1 year ago)
• Language: Python
• Homepage: https://ftcli.github.io/FoundryTools-CLI/
• Size: 1.85 MB
• Stars: 69
• Watchers: 7
• Forks: 4
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# FoundryTools-CLI

FoundryTools-CLI, former known as ftCLI, is a collection of command line tools written in Python to inspect, manipulate

and convert fonts. It takes advantage of the capabilities made available by other tools such as:

* [FontTools](https://github.com/fonttools/fonttools)

* [AFDKO](https://github.com/adobe-type-tools/afdko)

* [skia-pathops](https://github.com/fonttools/skia-pathops)

* [cffsubr](https://github.com/adobe-type-tools/cffsubr)

* [ttfautohint-py](https://github.com/fonttools/ttfautohint-py)

* [dehinter](https://github.com/source-foundry/dehinter)

![image](https://github.com/ftCLI/FoundryTools-CLI/assets/83063506/f648829c-3e3c-45ee-be3e-b5f9b35b30f7)

The command line interface is built with [click](https://github.com/pallets/click/) and tables are rendered by

[rich](https://github.com/Textualize/rich).

Even if not directly imported to keep the footprint as small as possible, portions of code have been copied from

[fontbakery](https://github.com/googlefonts/fontbakery) and [font-line](https://github.com/source-foundry/font-line).

## Installation

FoundryTools-CLI requires Python 3.9 or later.

**Note for Windows users**: installation on Python 3.11 and later may fail due to an error while building the wheel for

the `AFDKO` dependency. This is a known issue and a workaround is to install Visual Studio 2022 (Community Edition is

fine) and the `Python development` workload, selecting the `Python native development tools` optional component.

![image](https://github.com/ftCLI/FoundryTools-CLI/assets/83063506/3dcb4f74-bb94-4634-b28a-b6aeba7d8575)

**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://ftcli.github.io/FoundryTools-CLI/).

## License

FoundryTools-CLI is available under the [MIT license](LICENSE)

## Credits

To Sergiev. May You rest in peace.