Skip to main content

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

Project description

Build Status Appveyor Code Health 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 2.7, 3.4 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 Python 3 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.

  • 1.0 Documentation and testing complete.

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

  • 2.0 Python 3 only. 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.

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 includes Python 2.7 and 3.6, so for this to work the python2.7 and 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 py27-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.5.0.zip (154.5 kB view details)

Uploaded Source

Built Distribution

fontParts-0.5.0-py2.py3-none-any.whl (145.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file fontParts-0.5.0.zip.

File metadata

  • Download URL: fontParts-0.5.0.zip
  • Upload date:
  • Size: 154.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for fontParts-0.5.0.zip
Algorithm Hash digest
SHA256 dc6623b96a8bc090660f4d7b4a6cf5ce037970db2c25761f52ab6feb245e17c6
MD5 f55ac303f1f96a091f8adb05bf28d968
BLAKE2b-256 36729cb94377237f06b2cd9ee1b37e67229e59fc306ce6015d490e6c582e2722

See more details on using hashes here.

File details

Details for the file fontParts-0.5.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for fontParts-0.5.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 16c6c4e373e37aac2b712af09202f00d748e3c54533eda0c1085511172904765
MD5 da0d4746c10e38e6a87a94c27a3ed594
BLAKE2b-256 9e2c872ae78657d9ffdddd85bf8ecd8a74f319dd27919f5cffcdcf079a8aafc0

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