|
1 | 1 | ## font-size
|
| 2 | + |
| 3 | +[](https://github.com/source-foundry/font-size/actions/workflows/py-ci.yml) |
| 4 | +[](https://github.com/source-foundry/font-size/actions/workflows/py-lint.yml) |
| 5 | + |
| 6 | +## About |
| 7 | + |
| 8 | +font-size is a Python 3.6+ command line executable tool that reports *.otf, *.ttf, *.woff, and *.woff2 file and individual OpenType table sizes in a clean tabular format. |
| 9 | + |
| 10 | +## Installation |
| 11 | + |
| 12 | +`font-size` requires a Python 3.6+ interpreter. |
| 13 | + |
| 14 | +Installation in a [Python3 virtual environment](https://docs.python.org/3/library/venv.html) is recommended as dependencies are pinned to versions that are confirmed to work with this project. |
| 15 | + |
| 16 | +Use any of the following installation approaches: |
| 17 | + |
| 18 | +### pip install from PyPI |
| 19 | + |
| 20 | +``` |
| 21 | +$ pip3 install font-size |
| 22 | +``` |
| 23 | + |
| 24 | +### pip install from source |
| 25 | + |
| 26 | +``` |
| 27 | +$ git clone https://github.com/source-foundry/font-size.git |
| 28 | +$ cd font-size |
| 29 | +$ pip3 install . |
| 30 | +``` |
| 31 | + |
| 32 | +### Developer install from source |
| 33 | + |
| 34 | +The following approach installs the project and associated optional developer dependencies so that source changes are available without the need for re-installation. |
| 35 | + |
| 36 | +``` |
| 37 | +$ git clone https://github.com/source-foundry/font-size.git |
| 38 | +$ cd font-size |
| 39 | +$ pip3 install --ignore-installed -r requirements.txt -e ".[dev]" |
| 40 | +``` |
| 41 | + |
| 42 | +## Usage |
| 43 | + |
| 44 | +``` |
| 45 | +$ font-size [FONT PATH 1] [FONT PATH 2] ... [FONT PATH ...] |
| 46 | +``` |
| 47 | + |
| 48 | +## Issues |
| 49 | + |
| 50 | +Please report issues on the [project issue tracker](https://github.com/source-foundry/font-size/issues). |
| 51 | + |
| 52 | +## Contributing |
| 53 | + |
| 54 | +Contributions are welcome. A development dependency environment can be installed in editable mode with the developer installation documentation above. |
| 55 | + |
| 56 | +Please use the standard Github pull request approach to propose source changes. |
| 57 | + |
| 58 | +### Source file linting |
| 59 | + |
| 60 | +Python source files are linted with `flake8`. See the Makefile `test-lint` target for details. |
| 61 | + |
| 62 | + |
| 63 | +### Testing |
| 64 | + |
| 65 | +The project runs continuous integration testing on GitHub Actions runners with the `pytest` testing toolchain. Test modules are located in the `tests` directory of the repository. |
| 66 | + |
| 67 | +Local testing by Python interpreter version can be performed with the following command executed from the root of the repository: |
| 68 | + |
| 69 | +``` |
| 70 | +$ tox -e [PYTHON INTERPRETER VERSION] |
| 71 | +``` |
| 72 | + |
| 73 | +Please see the `tox` documentation for additional details. |
| 74 | + |
| 75 | +### Test coverage |
| 76 | + |
| 77 | +Unit test coverage is executed with the `coverage` tool. See the Makefile `test-coverage` target for details. |
| 78 | + |
| 79 | +## Acknowledgments |
| 80 | + |
| 81 | +`font-size` is built with the fantastic [fontTools free software library](https://github.com/fonttools/fonttools). |
| 82 | + |
| 83 | +## License |
| 84 | + |
| 85 | +Copyright 2021 Source Foundry Authors and Contributors |
| 86 | + |
| 87 | +Licensed under the Apache License, Version 2.0 (the "License"); |
| 88 | +you may not use this file except in compliance with the License. |
| 89 | +You may obtain a copy of the License at |
| 90 | + |
| 91 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 92 | + |
| 93 | +Unless required by applicable law or agreed to in writing, software |
| 94 | +distributed under the License is distributed on an "AS IS" BASIS, |
| 95 | +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 96 | +See the License for the specific language governing permissions and |
| 97 | +limitations under the License. |
0 commit comments