Metadata-Version: 2.1
Name: foundrytools-cli
Version: 1.0.2.1
Summary: A set of command line tools to inspect, manipulate and convert font files
Home-page: https://github.com/ftCLI/FoundryTools-CLI
Author: ftCLI
Author-email: ftcli@proton.me
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: afdko >=3.9.6
Requires-Dist: fonttools >=4.42.0
Requires-Dist: beziers >=0.5.0
Requires-Dist: brotli >=1.0.9
Requires-Dist: click >=8.1.6
Requires-Dist: cffsubr >=0.2.9.post1
Requires-Dist: dehinter >=4.0.0
Requires-Dist: pathvalidate >=3.1.0
Requires-Dist: psautohint >=2.4.0
Requires-Dist: rich >=13.5.2
Requires-Dist: skia-pathops >=0.7.4
Requires-Dist: ttfautohint-py >=0.5.1
Requires-Dist: zopfli >=0.2.2

# 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)
* [psautohint](https://github.com/adobe-type-tools/psautohint)
* [ttfautohint-py](https://github.com/fonttools/ttfautohint-py)
* [dehinter](https://github.com/source-foundry/dehinter)
* [beziers](https://github.com/simoncozens/beziers.py)

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 is strongly discouraged because AFDKO 3.9.6 doesn't support
it, and an attempt of installation would probably fail. Since macOS users successfully installed FoundryTools-CLI on
Python 3.11, requirements have been loosened up.

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

**IMPORTANT**: If you have Python 2.x installed in your system, you may have to use `python3` (instead of `python`) in
the commands below.

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



