https://github.com/beeware/travertino

A set of constants and utilities for describing user interfaces
https://github.com/beeware/travertino

Last synced: 3 months ago
JSON representation

A set of constants and utilities for describing user interfaces

• Host: GitHub
• URL: https://github.com/beeware/travertino
• Owner: beeware
• License: bsd-3-clause
• Created: 2017-12-07T14:17:42.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-04-07T23:38:58.000Z (10 months ago)
• Last Synced: 2024-04-08T22:47:01.705Z (10 months ago)
• Language: Python
• Homepage:
• Size: 425 KB
• Stars: 15
• Watchers: 10
• Forks: 16
• Open Issues: 1
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Authors: AUTHORS

Awesome Lists containing this project

README

        
.. |logo| image:: https://beeware.org/static/images/defaultlogo.png

    :width: 72px

    :target: https://beeware.org

.. |pyversions| image:: https://img.shields.io/pypi/pyversions/travertino.svg

    :target: https://pypi.python.org/pypi/travertino

    :alt: Python Versions

.. |version| image:: https://img.shields.io/pypi/v/travertino.svg

    :target: https://pypi.python.org/pypi/travertino

    :alt: Project version

.. |maturity| image:: https://img.shields.io/pypi/status/travertino.svg

    :target: https://pypi.python.org/pypi/travertino

    :alt: Project status

.. |license| image:: https://img.shields.io/pypi/l/travertino.svg

    :target: https://github.com/beeware/travertino/blob/main/LICENSE

    :alt: BSD License

.. |ci| image:: https://github.com/beeware/travertino/workflows/CI/badge.svg?branch=main

   :target: https://github.com/beeware/travertino/actions

   :alt: Build Status

.. |social| image:: https://img.shields.io/discord/836455665257021440?label=Discord%20Chat&logo=discord&style=plastic

   :target: https://beeware.org/bee/chat/

   :alt: Discord server

|logo|

Travertino

==========

|pyversions| |version| |maturity| |license| |ci| |social|

Travertino is a set of constants and utilities for describing user

interfaces, including:

* colors

* directions

* text alignment

* sizes

Usage

-----

Install Travertino:

    $ pip install travertino

Then in your python code, import and use it::

    >>> from travertino.colors import color, rgb,

    # Define a new color as an RGB triple

    >>> red = rgb(0xff, 0x00, 0x00)

    # Parse a color from a string

    >>> color('#dead00')

    rgb(0xde, 0xad, 0x00)

    # Reference a pre-defined color

    >>> color('RebeccaPurple')

    rgb(102, 51, 153)

Community

---------

Travertino is part of the `BeeWare suite`_. You can talk to the community through:

* `@[email protected] on Mastodon `__

* `Discord `__

We foster a welcoming and respectful community as described in our

`BeeWare Community Code of Conduct`_.

Contributing

------------

If you experience problems with Travertino, `log them on GitHub`_. If you

want to contribute code, please `fork the code`_ and `submit a pull request`_.

Travertino uses `Pre-commit `__ and  `TownCrier

`__ to help maintain code quality. For

details on how to use these tools as part of your development environment, see

the `Briefcase code contribution guide

`__.

Although that document is for a different project, the details about setting up

your development environment are the same.

.. _BeeWare suite: https://beeware.org

.. _Read The Docs: https://travertino.readthedocs.io

.. _BeeWare Community Code of Conduct: https://beeware.org/community/behavior/

.. _log them on Github: https://github.com/beeware/travertino/issues

.. _fork the code: https://github.com/beeware/travertino

.. _submit a pull request: https://github.com/beeware/travertino/pulls