## Tinta
<img width="200" alt="Tinta Logo" src="https://user-images.githubusercontent.com/1480253/118584629-38023b80-b74c-11eb-8511-05258af553fb.png" />
Tinta is a magical console output tool with support for printing in beautiful colors and with rich formatting, like bold and underline, using static, chain-able methods. It's so pretty, it's almost like a unicorn!
 [__](https://github.com/brandonscript/tinta/actions) [__](https://www.codacy.com/gh/brandonscript/tinta/dashboard?utm_source=github.com&utm_medium=referral&utm_content=brandonscript/tinta&utm_campaign=Badge_Grade)   [__](https://img.shields.io/badge/ethical-source-%23bb8c3c?labelColor=393162) [__](code_of_conduct.md)
## Features and Tinta Basics
`Tinta` takes a statically typed approach to handling rich-color console output.
In the past you might have fiddled with ANSI colors codes, or passed strings to a generic class, only to discover you typo'd one of them! (Yes, we've all been there).
But with `Tinta`, you can create your own `colors.ini` file, which dynamically generates builder pattern methods for `Tinta`. If you add a color for `wine` to your colors file, you can then use:
```python
from tinta import Tinta
Tinta.load_colors('colors.ini')
Tinta().wine('sip')
```
You can make a really simple drop-in `print()` replacement:
```python
Tinta('Our neural pathways have become accustomed '\
'to your sensory input patterns.').print()
```
Or you can create a variable to make things easier to read (or use control flows):
```python
from tinta import Tinta
children = True
t = Tinta().mint('Fate.')
t.dark_gray('It protects')
t.underline().red('fools')
if children:
t.normal().pink('little children')
else:
t.normal().yellow('spotted cats')
t.dark_gray(', and ships named')
t.mint("Enterprise.").print()
```
**_OK, neat, so how is that like unicorns?_**
Glad you asked! Here are some pretty pictures:
<img width="600" alt="Unicorns" src="https://user-images.githubusercontent.com/1480253/118717080-70e8f180-b7da-11eb-8ce8-08fe837fe73f.png" />
<br>
<img width="600" alt="Starbase" src="https://user-images.githubusercontent.com/1480253/118717091-734b4b80-b7da-11eb-9ecc-5cae5888878b.png" />
## Installation and Getting Started
### Install Tinta
```bash
pip install tinta
```
(Or visit https://pypi.org/project/tinta/)
### Add Tinta to your project
```python
from tinta import Tinta
Tinta('Elementary, my dear!').print()
```
### Create a `colors.ini` file
An example `colors.ini` file might look like:
```ini
# A list of ansi colors for your console.
green: 35
red: 1
blue: 32
yellow: 214
```
Or modify the `Tinta` colors.ini from [_here_](https://github.com/brandonscript/tinta/blob/main/tinta/colors.ini).
You can configure a path to your `colors.ini` file. This path can be relative, or absolute; the best way to make a path is using `pathlib.Path()`. Tinta will try and find the file in the current working directory, or you can specify a path:
```python
from pathlib import Path
from tinta import Tinta
Tinta.load_colors(Path().cwd() / 'config/colors.ini')
```
### Customizing your colors
You can use `Tinta.discover()` to discover what colors are available on your console.
```python
Tinta.discover()
# or to show the colors in the background
Tinta.discover(background=True)
```
<img src="https://github.com/brandonscript/tinta/blob/main/examples/tinta-discover.png?raw=true" style="max-width: 540px; !important" width="540" alt="Tinta.discover() output, a set of ANSI color-coded numbers in the terminal" />
## Tinta Basics
```python
from tinta import Tinta
Tinta('Unicorns are soft').print()
# prints: Unicorns are soft in plain text
Tinta('Unicorns are soft').pink().print()
# prints: Unicorns are soft in pink
Tinta('Unicorns are soft').pink().bold().print()
# prints: Unicorns are soft in bold pink
# You can chain as many methods as you want, and you can instantiate a single Tinta object
t = Tinta()
t.pink('Unicorns are soft, and').bold('very').normal('kind.')
t.print()
Tinta().pink('Unicorns are soft, and').bold('very').normal('kind.').print()
# prints: Unicorns are soft, and very kind.
# [--------pink--------][bold][normal]
# Notice how spaces are preserved between segments?
# You can change this with the sep arg:
Tinta().pink('Unicorns are soft, and', sep="").bold('very', sep="").normal('kind.').print()
# prints: Unicorns are soft,andvery kind.
# or...
Tinta().pink('Unicorns are soft, and').bold('very').normal('kind.').print(sep="")
# prints: Unicorns are soft, andverykind.
# Tinta will also try and automatically fix common punctuation issues that can occur when segments are joined together:
Tinta().pink('Unicorns are soft, and').purple(", you know,").bold('very').normal(', very, kind.').print()
# With smart fixing disabled, this would normally print:
# > Unicorns are soft, and , you know, very , very, kind.
# But with smart fixing enabled, it prints correctly:
# > Unicorns are soft, and, you know, very, very, kind.
# This is turned on by default, but you can disable this by setting TINTA_SMART_FIX_PUNCTUATION to `false` in your environment.
```
You can run the examples in the `examples/` directory to see more:
```bash
# check out the repo
git clone https://github.com/brandonscript/tinta.git
cd tinta
python examples/basic_example.py
```
## API Reference
### Tinta (+ color methods)
#### Dynamic methods
These methods are loaded dynamically from your `colors.ini` file:
```python
Tinta().green()
Tinta().red()
Tinta().blue()
Tinta().wine()
Tinta().my_color()
# etc.
```
A note on linters like Pylance or pylint: these methods are dynamically generated, so they won't be recognized by your linter. Until Python natively supports type definitions for dynamically generated code, you will have to suppress these warnings:
```python
# pyright: reportGeneralTypeIssues=false
Tinta().green() # or
# pylint: disable=no-member
Tinta().green()
```
If this is frustrating, you can always use the `Tinta.code(<int>)` or the `Tinta.tint(<color>)` methods, which are not dynamically generated.
### Common Args
All "add" methods (each color and style method, `Tinta()`, `push()`, and `tint`) take the following common args:
- `s (str)` – A sequence of one or more text strings, to be joined together.
- `sep (str)` – Used to join segment strings. Defaults to `' '`.
> _Note: `sep` behavior has been changed in v0.1.6 - if passing a `sep` argument in `print()`, it will overwrite any segment's individual `sep` argument._
For example:
```python
Tinta('A set', 'of strings', 'joined', 'with', 'semicolons', sep=';').print()
```
```bash
~ » A set;of strings;joined;with;semicolons
```
(or)
```python
Tinta('A set', 'of strings', 'joined', 'with', 'double spaces').print(sep=' ')
```
```bash
~ » A set of strings joined with double spaces
```
### Attributes
All `Tinta` and dynamic color methods will make available the following attributes:
- `color (str)` — A color string or ANSI color code (int), e.g. 'white' or 42.
- `style (str)` — A style string, e.g. 'bold', 'dim', 'underline'. Multiple styles are joined with a +.
- `parts (list)` — A list of `Tinta.Part` segments, which each have a `fmt`, `pln`, and `esc` attribute.
- ~~`parts_plaintext (list)` — A list of unstyled text segments.~~
### Built-in Methods
_See below for detailed usage and arguments._
> (Note: breaking changes in v0.1.6 - several methods have been renamed for better semantics).
- `print()` – Prints to the console.
- `to_str() -> str` – Returns a joined text string.
- `discover()` – Prints a list of available colors to the console.
Remember, all of the following methods return the current `Tinta` instance `-> self` so you can chain styles together:
- `()` or `push()` – Adds another segment using the previous style. Replaces `add()`.
- `pop()` – Removes the last segment. This is useful if you want to remove a segment that was added with `push()`.
- `tint()` – Behaves like `.push()`, but adds segments using the specified color string or ANSI code. Replaces `code()`.
- `nl()` – Appends the contents preceded by a newline char (`\n`). Renamed from `line()`.
- `clear()` – Clears all styling for the next segment so it uses terminal default styling. Replaces `reset()`.
- `b()` or `bold()` – Adds a **bold** segment.
- `_()` or `u()` or `underline()` – Adds an ~underlined~ segment.
- `dim()` – Adds a darker, dimmed segment.
- `normal()` – Resets the style, but retains any active color.
#### `print()`
Prints to the console. Probably the most important method, because if you don't print, you don't see anything at all!
A good first step in troubleshooting is checking that you remembered to `print()` (ask me how I know...)
This supports all the built-in Python 3 `print()` methods, too (`sep`, `end`, `file`, `flush`), as well as:
- `sep (str)` – Used to join segment strings. Defaults to `' '`.
- `plaintext (bool)` – Returns a compiled plaintext string
- `escape_ansi (bool)` – If True, escapes ANSI codes with a double \\. Defaults to `False`.
- `fix_punctuation (bool)` – If True, fixes common punctuation issues. Defaults to `True`, or the value of `'env::TINTA_SMART_FIX_PUNCTUATION'`.
and
- `s* (str)` – You can also pass any arbitrary sequence of strings to `print()` to push additional segments.
```python
# Prints in plaintext
Tinta().purple("Is it a bird?").print("No, maybe it's a...", plaintext=True)
# Always prints, even if 'env::TINTA_STEALTH' is set)
Tinta().green('Plane?').print(force=True)
```
It's also important to note that `print()` doesn't make a variable unusable, but it will reset and remove all styles and previous segments. This means you can do:
```python
t = Tinta()
t.blue('A cloud').print()
t.green('An old, wise, and very small alien').print()
```
#### `to_str()`
> _Previously `text()`_
Constructs the string that would be sent to `print()`, but returns it instead of printing it. Accepts all the same arguments as `print()` except `file` and `flush`.
#### `()` or `push()`
> _Previously_ `add()`
Sometimes you want the convenience of readability without changing styles, or you might want to use control flow to set a variable. For these, you can directly chain any `Tinta` object via its `__call__` method, or via `push()`:
```python
t = Tinta().gray('I am a bear')
if you_love_bears:
t.pink('and I love bears!')
else:
t('but I am sad.')
# or
t.push('but I am sad.')
t.print()
Tinta().brown('I')('am a brown bear').black(', and I am a')('black bear.').print()
```
#### `nl()`
Adds a text segment preceded by a newline.
```python
Tinta('A cat').line('scratches').print()
# A cat
# scratches
```
#### `tint()`
Sometimes you might want to use a color by string name, or one that wasn't defined in your `colors.ini`. For that, you can use `tint()`.
> _Note: some of this functionality was previously in `code()`, which is now combined into `tint()`._
Just set the `color` kwarg to specify an ANSI color code or string name:
```python
Tinta().tint('A bear who knows all the answers', color=42).print()
Tinta().tint('A brown bear', color='brown').print()
```
## Environment Variables
Sometimes it's useful to globally configure `Tinta` on a system where you might want it to behave differently, without changing your source code. If these Environment variables are present on the system, they will be considered True.
`TINTA_STEALTH` – Disables console output globally
`TINTA_PLAINTEXT` – Disables rich console output, only printing plain text.
`TINTA_SEPARATOR` – Changes the default separator (`' '`) to this value.
`TINTA_SMART_FIX_PUNCTUATION` – Controls smart punctuation fixing (default: `true`)
## Running Tests
To run tests, run the following command:
```bash
pip install pytest
python -m pytest -xv
```
## Contributing
Contributions are welcome! Please send in a PR with a clear explanation of what you're adding and why, and where applicable, add tests to validate. Please read our [_code of conduct_](CODE_OF_CONDUCT.md) before contributing.
## Acknowledgements
Special thanks to [_@katherinecodes_](https://twitter.com/katherinecodes) for [_readme.so_](https://readme.so/), [_@jessicaspacekat_](https://twitter.com/jessicaspacekat) for [_rikeripsum.com_](http://rikeripsum.com), and [_ansicolors_](https://github.com/jonathaneunice/colors/).
## License
Tinta is licensed under the [_MIT License_](LICENSE). If you use this software, you must also agree under the terms of the Hippocratic License 3.0 to not use this software in a way that directly or indirectly causes harm. You can find the full text of the license at https://firstdonoharm.dev.
Raw data
{
"_id": null,
"home_page": "",
"name": "tinta",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "ansi,cli,colors,console,development,print,term,terminal",
"author": "",
"author_email": "Brandon Shelley <brandon@pacificaviator.co>",
"download_url": "https://files.pythonhosted.org/packages/0d/09/9ed95ee65d729435f9faeb6b8f9b36a9c5b88a1d95c87bd1d9550374c8d0/tinta-0.1.6.tar.gz",
"platform": null,
"description": "## Tinta\n\n<img width=\"200\" alt=\"Tinta Logo\" src=\"https://user-images.githubusercontent.com/1480253/118584629-38023b80-b74c-11eb-8511-05258af553fb.png\" />\n\nTinta is a magical console output tool with support for printing in beautiful colors and with rich formatting, like bold and underline, using static, chain-able methods. It's so pretty, it's almost like a unicorn!\n\n [__](https://github.com/brandonscript/tinta/actions) [__](https://www.codacy.com/gh/brandonscript/tinta/dashboard?utm_source=github.com&utm_medium=referral&utm_content=brandonscript/tinta&utm_campaign=Badge_Grade)   [__](https://img.shields.io/badge/ethical-source-%23bb8c3c?labelColor=393162) [__](code_of_conduct.md)\n\n## Features and Tinta Basics\n\n`Tinta` takes a statically typed approach to handling rich-color console output.\n\nIn the past you might have fiddled with ANSI colors codes, or passed strings to a generic class, only to discover you typo'd one of them! (Yes, we've all been there).\n\nBut with `Tinta`, you can create your own `colors.ini` file, which dynamically generates builder pattern methods for `Tinta`. If you add a color for `wine` to your colors file, you can then use:\n\n```python\nfrom tinta import Tinta\nTinta.load_colors('colors.ini')\nTinta().wine('sip')\n```\n\nYou can make a really simple drop-in `print()` replacement:\n\n```python\nTinta('Our neural pathways have become accustomed '\\\n 'to your sensory input patterns.').print()\n```\n\nOr you can create a variable to make things easier to read (or use control flows):\n\n```python\nfrom tinta import Tinta\n\nchildren = True\n\nt = Tinta().mint('Fate.')\nt.dark_gray('It protects')\nt.underline().red('fools')\n\nif children:\n t.normal().pink('little children')\nelse:\n t.normal().yellow('spotted cats')\n\nt.dark_gray(', and ships named')\nt.mint(\"Enterprise.\").print()\n```\n\n**_OK, neat, so how is that like unicorns?_**\n\nGlad you asked! Here are some pretty pictures:\n\n<img width=\"600\" alt=\"Unicorns\" src=\"https://user-images.githubusercontent.com/1480253/118717080-70e8f180-b7da-11eb-8ce8-08fe837fe73f.png\" />\n<br>\n<img width=\"600\" alt=\"Starbase\" src=\"https://user-images.githubusercontent.com/1480253/118717091-734b4b80-b7da-11eb-9ecc-5cae5888878b.png\" />\n\n## Installation and Getting Started\n\n### Install Tinta\n\n```bash\npip install tinta\n```\n\n(Or visit https://pypi.org/project/tinta/)\n\n### Add Tinta to your project\n\n```python\nfrom tinta import Tinta\n\nTinta('Elementary, my dear!').print()\n```\n\n### Create a `colors.ini` file\n\nAn example `colors.ini` file might look like:\n\n```ini\n# A list of ansi colors for your console.\ngreen: 35\nred: 1\nblue: 32\nyellow: 214\n```\n\nOr modify the `Tinta` colors.ini from [_here_](https://github.com/brandonscript/tinta/blob/main/tinta/colors.ini).\n\nYou can configure a path to your `colors.ini` file. This path can be relative, or absolute; the best way to make a path is using `pathlib.Path()`. Tinta will try and find the file in the current working directory, or you can specify a path:\n\n```python\nfrom pathlib import Path\nfrom tinta import Tinta\nTinta.load_colors(Path().cwd() / 'config/colors.ini')\n```\n\n### Customizing your colors\n\nYou can use `Tinta.discover()` to discover what colors are available on your console.\n\n```python\nTinta.discover()\n# or to show the colors in the background\nTinta.discover(background=True)\n```\n\n<img src=\"https://github.com/brandonscript/tinta/blob/main/examples/tinta-discover.png?raw=true\" style=\"max-width: 540px; !important\" width=\"540\" alt=\"Tinta.discover() output, a set of ANSI color-coded numbers in the terminal\" />\n\n## Tinta Basics\n\n```python\nfrom tinta import Tinta\n\nTinta('Unicorns are soft').print()\n# prints: Unicorns are soft in plain text\n\nTinta('Unicorns are soft').pink().print()\n# prints: Unicorns are soft in pink\n\nTinta('Unicorns are soft').pink().bold().print()\n# prints: Unicorns are soft in bold pink\n\n# You can chain as many methods as you want, and you can instantiate a single Tinta object\nt = Tinta()\nt.pink('Unicorns are soft, and').bold('very').normal('kind.')\nt.print()\nTinta().pink('Unicorns are soft, and').bold('very').normal('kind.').print()\n# prints: Unicorns are soft, and very kind.\n# [--------pink--------][bold][normal]\n\n# Notice how spaces are preserved between segments?\n# You can change this with the sep arg:\nTinta().pink('Unicorns are soft, and', sep=\"\").bold('very', sep=\"\").normal('kind.').print()\n# prints: Unicorns are soft,andvery kind.\n# or...\nTinta().pink('Unicorns are soft, and').bold('very').normal('kind.').print(sep=\"\")\n# prints: Unicorns are soft, andverykind.\n\n# Tinta will also try and automatically fix common punctuation issues that can occur when segments are joined together:\nTinta().pink('Unicorns are soft, and').purple(\", you know,\").bold('very').normal(', very, kind.').print()\n# With smart fixing disabled, this would normally print:\n# > Unicorns are soft, and , you know, very , very, kind.\n\n# But with smart fixing enabled, it prints correctly:\n# > Unicorns are soft, and, you know, very, very, kind.\n\n# This is turned on by default, but you can disable this by setting TINTA_SMART_FIX_PUNCTUATION to `false` in your environment.\n```\n\nYou can run the examples in the `examples/` directory to see more:\n\n```bash\n# check out the repo\ngit clone https://github.com/brandonscript/tinta.git\ncd tinta\npython examples/basic_example.py\n```\n\n## API Reference\n\n### Tinta (+ color methods)\n\n#### Dynamic methods\n\nThese methods are loaded dynamically from your `colors.ini` file:\n\n```python\nTinta().green()\nTinta().red()\nTinta().blue()\nTinta().wine()\nTinta().my_color()\n# etc.\n```\n\nA note on linters like Pylance or pylint: these methods are dynamically generated, so they won't be recognized by your linter. Until Python natively supports type definitions for dynamically generated code, you will have to suppress these warnings:\n\n```python\n# pyright: reportGeneralTypeIssues=false\nTinta().green() # or\n# pylint: disable=no-member\nTinta().green()\n```\n\nIf this is frustrating, you can always use the `Tinta.code(<int>)` or the `Tinta.tint(<color>)` methods, which are not dynamically generated.\n\n### Common Args\n\nAll \"add\" methods (each color and style method, `Tinta()`, `push()`, and `tint`) take the following common args:\n\n- `s (str)` \u2013 A sequence of one or more text strings, to be joined together.\n- `sep (str)` \u2013 Used to join segment strings. Defaults to `' '`.\n > _Note: `sep` behavior has been changed in v0.1.6 - if passing a `sep` argument in `print()`, it will overwrite any segment's individual `sep` argument._\n\nFor example:\n\n```python\nTinta('A set', 'of strings', 'joined', 'with', 'semicolons', sep=';').print()\n```\n\n```bash\n~ \u00bb A set;of strings;joined;with;semicolons\n```\n\n(or)\n\n```python\nTinta('A set', 'of strings', 'joined', 'with', 'double spaces').print(sep=' ')\n```\n\n```bash\n~ \u00bb A set of strings joined with double spaces\n```\n\n### Attributes\n\nAll `Tinta` and dynamic color methods will make available the following attributes:\n\n- `color (str)` \u2014 A color string or ANSI color code (int), e.g. 'white' or 42.\n- `style (str)` \u2014 A style string, e.g. 'bold', 'dim', 'underline'. Multiple styles are joined with a +.\n- `parts (list)` \u2014 A list of `Tinta.Part` segments, which each have a `fmt`, `pln`, and `esc` attribute.\n- ~~`parts_plaintext (list)` \u2014 A list of unstyled text segments.~~\n\n### Built-in Methods\n\n_See below for detailed usage and arguments._\n\n> (Note: breaking changes in v0.1.6 - several methods have been renamed for better semantics).\n\n- `print()` \u2013\u00a0Prints to the console.\n- `to_str() -> str` \u2013\u00a0Returns a joined text string.\n- `discover()` \u2013 Prints a list of available colors to the console.\n\nRemember, all of the following methods return the current `Tinta` instance `-> self` so you can chain styles together:\n\n- `()` or `push()` \u2013 Adds another segment using the previous style. Replaces `add()`.\n- `pop()` \u2013 Removes the last segment. This is useful if you want to remove a segment that was added with `push()`.\n- `tint()` \u2013 Behaves like `.push()`, but adds segments using the specified color string or ANSI code. Replaces `code()`.\n- `nl()` \u2013 Appends the contents preceded by a newline char (`\\n`). Renamed from `line()`.\n- `clear()` \u2013 Clears all styling for the next segment so it uses terminal default styling. Replaces `reset()`.\n\n- `b()` or `bold()` \u2013 Adds a **bold** segment.\n- `_()` or `u()` or `underline()` \u2013\u00a0Adds an ~underlined~ segment.\n- `dim()` \u2013 Adds a darker, dimmed segment.\n- `normal()` \u2013 Resets the style, but retains any active color.\n\n#### `print()`\n\nPrints to the console. Probably the most important method, because if you don't print, you don't see anything at all!\nA good first step in troubleshooting is checking that you remembered to `print()` (ask me how I know...)\n\nThis supports all the built-in Python 3 `print()` methods, too (`sep`, `end`, `file`, `flush`), as well as:\n\n- `sep (str)` \u2013\u00a0Used to join segment strings. Defaults to `' '`.\n- `plaintext (bool)` \u2013\u00a0Returns a compiled plaintext string\n- `escape_ansi (bool)` \u2013\u00a0If True, escapes ANSI codes with a double \\\\. Defaults to `False`.\n- `fix_punctuation (bool)` \u2013\u00a0If True, fixes common punctuation issues. Defaults to `True`, or the value of `'env::TINTA_SMART_FIX_PUNCTUATION'`.\n and\n- `s* (str)` \u2013\u00a0You can also pass any arbitrary sequence of strings to `print()` to push additional segments.\n\n```python\n# Prints in plaintext\nTinta().purple(\"Is it a bird?\").print(\"No, maybe it's a...\", plaintext=True)\n\n# Always prints, even if 'env::TINTA_STEALTH' is set)\nTinta().green('Plane?').print(force=True)\n```\n\nIt's also important to note that `print()` doesn't make a variable unusable, but it will reset and remove all styles and previous segments. This means you can do:\n\n```python\nt = Tinta()\n\nt.blue('A cloud').print()\nt.green('An old, wise, and very small alien').print()\n```\n\n#### `to_str()`\n\n> _Previously `text()`_\n\nConstructs the string that would be sent to `print()`, but returns it instead of printing it. Accepts all the same arguments as `print()` except `file` and `flush`.\n\n#### `()` or `push()`\n\n> _Previously_ `add()`\n\nSometimes you want the convenience of readability without changing styles, or you might want to use control flow to set a variable. For these, you can directly chain any `Tinta` object via its `__call__` method, or via `push()`:\n\n```python\nt = Tinta().gray('I am a bear')\nif you_love_bears:\n t.pink('and I love bears!')\nelse:\n t('but I am sad.')\n # or\n t.push('but I am sad.')\nt.print()\n\nTinta().brown('I')('am a brown bear').black(', and I am a')('black bear.').print()\n```\n\n#### `nl()`\n\nAdds a text segment preceded by a newline.\n\n```python\nTinta('A cat').line('scratches').print()\n# A cat\n# scratches\n```\n\n#### `tint()`\n\nSometimes you might want to use a color by string name, or one that wasn't defined in your `colors.ini`. For that, you can use `tint()`.\n\n> _Note: some of this functionality was previously in `code()`, which is now combined into `tint()`._\n\nJust set the `color` kwarg to specify an ANSI color code or string name:\n\n```python\nTinta().tint('A bear who knows all the answers', color=42).print()\nTinta().tint('A brown bear', color='brown').print()\n```\n\n## Environment Variables\n\nSometimes it's useful to globally configure `Tinta` on a system where you might want it to behave differently, without changing your source code. If these Environment variables are present on the system, they will be considered True.\n\n`TINTA_STEALTH` \u2013 Disables console output globally\n\n`TINTA_PLAINTEXT` \u2013 Disables rich console output, only printing plain text.\n\n`TINTA_SEPARATOR` \u2013 Changes the default separator (`' '`) to this value.\n\n`TINTA_SMART_FIX_PUNCTUATION` \u2013\u00a0Controls smart punctuation fixing (default: `true`)\n\n## Running Tests\n\nTo run tests, run the following command:\n\n```bash\npip install pytest\npython -m pytest -xv\n```\n\n## Contributing\n\nContributions are welcome! Please send in a PR with a clear explanation of what you're adding and why, and where applicable, add tests to validate. Please read our [_code of conduct_](CODE_OF_CONDUCT.md) before contributing.\n\n## Acknowledgements\n\nSpecial thanks to [_@katherinecodes_](https://twitter.com/katherinecodes) for [_readme.so_](https://readme.so/), [_@jessicaspacekat_](https://twitter.com/jessicaspacekat) for [_rikeripsum.com_](http://rikeripsum.com), and [_ansicolors_](https://github.com/jonathaneunice/colors/).\n\n## License\n\nTinta is licensed under the [_MIT License_](LICENSE). If you use this software, you must also agree under the terms of the Hippocratic License 3.0 to not use this software in a way that directly or indirectly causes harm. You can find the full text of the license at https://firstdonoharm.dev.\n",
"bugtrack_url": null,
"license": "",
"summary": "Tinta, a magical console output tool.",
"version": "0.1.6",
"project_urls": {
"homepage": "https://github.com/brandonscript/tinta",
"repository": "https://github.com/brandonscript/tinta"
},
"split_keywords": [
"ansi",
"cli",
"colors",
"console",
"development",
"print",
"term",
"terminal"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0d099ed95ee65d729435f9faeb6b8f9b36a9c5b88a1d95c87bd1d9550374c8d0",
"md5": "34fea2289635e16b2b93f92b0b54ecb0",
"sha256": "106393ffab5194f90607e8344798e76034015f916d438fb75585407bdfca3941"
},
"downloads": -1,
"filename": "tinta-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "34fea2289635e16b2b93f92b0b54ecb0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 238801,
"upload_time": "2024-03-11T05:42:43",
"upload_time_iso_8601": "2024-03-11T05:42:43.966295Z",
"url": "https://files.pythonhosted.org/packages/0d/09/9ed95ee65d729435f9faeb6b8f9b36a9c5b88a1d95c87bd1d9550374c8d0/tinta-0.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-11 05:42:43",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "brandonscript",
"github_project": "tinta",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "tinta"
}
JSON
