Introduction
============
.. image:: https://readthedocs.org/projects/adafruit-circuitpython-bitmap_font/badge/?version=latest
:target: https://docs.circuitpython.org/projects/bitmap-font/en/latest/
:alt: Documentation Status
.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg
:target: https://adafru.it/discord
:alt: Discord
.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Bitmap_Font/workflows/Build%20CI/badge.svg
:target: https://github.com/adafruit/Adafruit_CircuitPython_Bitmap_Font/actions/
:alt: Build Status
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
:target: https://github.com/psf/black
:alt: Code Style: Black
Loads bitmap fonts into CircuitPython's displayio. BDF and PCF files are well supported. TTF
support is not yet complete.
Dependencies
=============
This driver depends on:
* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_
Please ensure all dependencies are available on the CircuitPython filesystem.
This is easily achieved by downloading
`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.
Installing from PyPI
--------------------
On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from
PyPI <https://pypi.org/project/adafruit-circuitpython-bitmap_font/>`_. To install for current user:
.. code-block:: shell
pip3 install adafruit-circuitpython-bitmap_font
To install system-wide (this may be required in some cases):
.. code-block:: shell
sudo pip3 install adafruit-circuitpython-bitmap_font
To install in a virtual environment in your current project:
.. code-block:: shell
mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-bitmap_font
Usage Example
=============
.. code-block:: python
from adafruit_bitmap_font import bitmap_font
from displayio import Bitmap
font = bitmap_font.load_font("fonts/LeagueSpartan-Bold-16.bdf", Bitmap)
print(font.get_glyph(ord("A")))
Creating Fonts
==============
See `this learn guide <https://learn.adafruit.com/custom-fonts-for-pyportal-circuitpython-display>`_ for more information about building custom font files.
The command line tool :code:`otf2bdf` can be used make bdf files for use with this library.
The command line tool :code:`bdftopcf` can be used make pcf files for use with this library.
Documentation
=============
API documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/bitmap-font/en/latest/>`_.
For information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.
Contributing
============
Contributions are welcome! Please read our `Code of Conduct
<https://github.com/adafruit/Adafruit_CircuitPython_Bitmap_Font/blob/main/CODE_OF_CONDUCT.md>`_
before contributing to help this project stay welcoming.
Raw data
{
"_id": null,
"home_page": null,
"name": "adafruit-circuitpython-bitmap-font",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "adafruit, blinka, circuitpython, micropython, font, text, displayio, bitmap",
"author": null,
"author_email": "Adafruit Industries <circuitpython@adafruit.com>",
"download_url": "https://files.pythonhosted.org/packages/fa/f5/91b6e4a92c8867b4c6cf8c99c3c74890986b0b3858f43628454fa57364b1/adafruit_circuitpython_bitmap_font-2.1.2.tar.gz",
"platform": null,
"description": "Introduction\n============\n\n.. image:: https://readthedocs.org/projects/adafruit-circuitpython-bitmap_font/badge/?version=latest\n :target: https://docs.circuitpython.org/projects/bitmap-font/en/latest/\n :alt: Documentation Status\n\n.. image:: https://raw.githubusercontent.com/adafruit/Adafruit_CircuitPython_Bundle/main/badges/adafruit_discord.svg\n :target: https://adafru.it/discord\n :alt: Discord\n\n.. image:: https://github.com/adafruit/Adafruit_CircuitPython_Bitmap_Font/workflows/Build%20CI/badge.svg\n :target: https://github.com/adafruit/Adafruit_CircuitPython_Bitmap_Font/actions/\n :alt: Build Status\n\n.. image:: https://img.shields.io/badge/code%20style-black-000000.svg\n :target: https://github.com/psf/black\n :alt: Code Style: Black\n\nLoads bitmap fonts into CircuitPython's displayio. BDF and PCF files are well supported. TTF\nsupport is not yet complete.\n\nDependencies\n=============\nThis driver depends on:\n\n* `Adafruit CircuitPython <https://github.com/adafruit/circuitpython>`_\n\nPlease ensure all dependencies are available on the CircuitPython filesystem.\nThis is easily achieved by downloading\n`the Adafruit library and driver bundle <https://github.com/adafruit/Adafruit_CircuitPython_Bundle>`_.\n\nInstalling from PyPI\n--------------------\nOn supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally `from\nPyPI <https://pypi.org/project/adafruit-circuitpython-bitmap_font/>`_. To install for current user:\n\n.. code-block:: shell\n\n pip3 install adafruit-circuitpython-bitmap_font\n\nTo install system-wide (this may be required in some cases):\n\n.. code-block:: shell\n\n sudo pip3 install adafruit-circuitpython-bitmap_font\n\nTo install in a virtual environment in your current project:\n\n.. code-block:: shell\n\n mkdir project-name && cd project-name\n python3 -m venv .venv\n source .venv/bin/activate\n pip3 install adafruit-circuitpython-bitmap_font\n\nUsage Example\n=============\n\n.. code-block:: python\n\n from adafruit_bitmap_font import bitmap_font\n from displayio import Bitmap\n font = bitmap_font.load_font(\"fonts/LeagueSpartan-Bold-16.bdf\", Bitmap)\n print(font.get_glyph(ord(\"A\")))\n\n\nCreating Fonts\n==============\n\nSee `this learn guide <https://learn.adafruit.com/custom-fonts-for-pyportal-circuitpython-display>`_ for more information about building custom font files.\n\nThe command line tool :code:`otf2bdf` can be used make bdf files for use with this library.\n\nThe command line tool :code:`bdftopcf` can be used make pcf files for use with this library.\n\nDocumentation\n=============\n\nAPI documentation for this library can be found on `Read the Docs <https://docs.circuitpython.org/projects/bitmap-font/en/latest/>`_.\n\nFor information on building library documentation, please check out `this guide <https://learn.adafruit.com/creating-and-sharing-a-circuitpython-library/sharing-our-docs-on-readthedocs#sphinx-5-1>`_.\n\nContributing\n============\n\nContributions are welcome! Please read our `Code of Conduct\n<https://github.com/adafruit/Adafruit_CircuitPython_Bitmap_Font/blob/main/CODE_OF_CONDUCT.md>`_\nbefore contributing to help this project stay welcoming.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Loads bitmap fonts into CircuitPython displayio.",
"version": "2.1.2",
"project_urls": {
"Homepage": "https://github.com/adafruit/Adafruit_CircuitPython_Bitmap_Font"
},
"split_keywords": [
"adafruit",
" blinka",
" circuitpython",
" micropython",
" font",
" text",
" displayio",
" bitmap"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "467e42bbd5cc56175d5664fb7dda1e87a90dc85fe4a9c9e83b4a63ecfd4738c2",
"md5": "1701c5c0681f2ffea5ef0b9b2999c87b",
"sha256": "5312c95b533fbf4d4ac00f2d1cbd309b7fc6e37c464a416fcbdff5ce93647b74"
},
"downloads": -1,
"filename": "adafruit_circuitpython_bitmap_font-2.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1701c5c0681f2ffea5ef0b9b2999c87b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 12661,
"upload_time": "2024-06-03T17:49:31",
"upload_time_iso_8601": "2024-06-03T17:49:31.813831Z",
"url": "https://files.pythonhosted.org/packages/46/7e/42bbd5cc56175d5664fb7dda1e87a90dc85fe4a9c9e83b4a63ecfd4738c2/adafruit_circuitpython_bitmap_font-2.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "faf591b6e4a92c8867b4c6cf8c99c3c74890986b0b3858f43628454fa57364b1",
"md5": "e48fc709e6911bdd1fb07df2b039be9d",
"sha256": "7c02885c3e916532e4791fa51aeab3a3f6f3e6f96bf86ee3fe950a2d05fca1ec"
},
"downloads": -1,
"filename": "adafruit_circuitpython_bitmap_font-2.1.2.tar.gz",
"has_sig": false,
"md5_digest": "e48fc709e6911bdd1fb07df2b039be9d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 173414,
"upload_time": "2024-06-03T17:49:33",
"upload_time_iso_8601": "2024-06-03T17:49:33.670044Z",
"url": "https://files.pythonhosted.org/packages/fa/f5/91b6e4a92c8867b4c6cf8c99c3c74890986b0b3858f43628454fa57364b1/adafruit_circuitpython_bitmap_font-2.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-03 17:49:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "adafruit",
"github_project": "Adafruit_CircuitPython_Bitmap_Font",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "Adafruit-Blinka",
"specs": []
},
{
"name": "adafruit-blinka-displayio",
"specs": []
}
],
"lcname": "adafruit-circuitpython-bitmap-font"
}
JSON
