Skip to main content

An API for interacting with the parts of fonts during the font development process.

Project description

CI Build Status Coverage Codacy PyPI Python Versions

FontParts

An API for interacting with the parts of fonts during the font development process. FontParts is the replacement for RoboFab. The project has a MIT open-source licence.

The documentation is at fontparts.readthedocs.io.

This is a work in progress. We are still working out the API, abstract implementation, example implementation, test suite and documentation.

Want to contribute?

Thank you! Please see the CONTRIBUTING.rst file for a guide on how to help.

Also, feedback is very much welcome, please open an issue when you run into something that you wish fontParts did/didn’t do.

Installation

FontParts requires Python 3.6 or later.

The package is listed in the Python Package Index (PyPI), so you can install it with pip:

pip install fontParts

If you would like to contribute to its development, you can clone the repository from Github, install the package in ‘editable’ mode and modify the source code in place. We recommend creating a virtual environment, using virtualenv or venv module.

# download the source code to 'fontParts' folder
git clone https://github.com/robofab-developers/fontParts.git
cd fontParts

# create new virtual environment called e.g. 'fontParts-venv', or anything you like
python -m virtualenv fontParts-venv

# source the `activate` shell script to enter the environment (Un\*x); to exit, just type `deactivate`
. fontParts-venv/bin/activate

# to activate the virtual environment in Windows `cmd.exe`, do
fontParts-venv\Scripts\activate.bat

# install in 'editable' mode
pip install -e .

Roadmap

We are currently working towards the 1.0 release.

  • 0.8 Initial releases. Python 2 & 3.

  • 0.9 Python 3 only.

  • 1.0 Documentation and testing complete.

  • 1.5 Removal of Deprecated. Released 1 year after 1.0.

Testing

Testing is setup so that each environment that includes fontParts can provides the objects needed to run a common set of tests. This makes testing very easy for environments that use fontParts (for example, see the fontshell test.py script), but it means testing is different than other python packages.

Automated testing of the package is done in the fontshell environment. fontshell is fontParts for the commandline, implemented with defcon and is included as part of the fontParts package.

Before you can run the test suite you’ll need to install the test dependencies:

pip install -r dev-requirements.txt

To run the test suite you can do:

python Lib/fontParts/fontshell/test.py

To test in other environments, run the test script provided by that environment.

You can also use tox to automatically run tests on different Python versions in isolated virtual environments.

pip install tox
tox

Note that when you run tox without arguments, the tests are executed for all the environments listed in tox.ini’s envlist. In our case, this is Python 3.6, so for this to work the python3.6 executables must be available in your PATH.

You can specify an alternative environment list via the -e option, or the TOXENV environment variable:

tox -e py39-nocov
TOXENV="py36-cov,htmlcov" tox

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fontParts-0.9.7.zip (494.8 kB view details)

Uploaded Source

Built Distribution

fontParts-0.9.7-py3-none-any.whl (161.4 kB view details)

Uploaded Python 3

File details

Details for the file fontParts-0.9.7.zip.

File metadata

  • Download URL: fontParts-0.9.7.zip
  • Upload date:
  • Size: 494.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.1

File hashes

Hashes for fontParts-0.9.7.zip
Algorithm Hash digest
SHA256 fe61b7b196577b7d9ecc1f376f1f48d154bd1706647bab889fa4e115820f7ea0
MD5 10ad2bea95b2a2a124ddbc8b94440d44
BLAKE2b-256 21508ac81e04601c8cae3d4c047ccb21a8a30bd69e42d8d20a2db60071365ed0

See more details on using hashes here.

File details

Details for the file fontParts-0.9.7-py3-none-any.whl.

File metadata

  • Download URL: fontParts-0.9.7-py3-none-any.whl
  • Upload date:
  • Size: 161.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.1 setuptools/49.2.1 requests-toolbelt/0.9.1 tqdm/4.54.1 CPython/3.9.1

File hashes

Hashes for fontParts-0.9.7-py3-none-any.whl
Algorithm Hash digest
SHA256 514bf603a14225f7f3456adb38732af7d326a056ed0e3b78503e42c1d0ae306a
MD5 9f76bd5c64d24ca50628f42764accf89
BLAKE2b-256 9cef15bbf2e36061807ed0c536ac5aa94a204a721f5b3e7796828db124cc7362

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page