Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased - 202x-xx-xx

Added

CI to automatically publish releases on tag creation

Changed

Level up the packaging using hatchling
Updated README's code example (fixes #13)

Removed

2.7.0 - 2024-04-23

Added

Support for Python 3.12
CI to run unit tests
Tests for the CLI entry point

Changed

Set the default chart name to a blank string in the CLI (fixes #9)
Use shutil.get_terminal_size() instead of os.get_terminal_size() to be able to run tests without hitting OSError: [Errno 25] Inappropriate ioctl for device
Fix Mypy error PEP 484 prohibits implicit Optional

2.6.0 - 2023-04-14

Added

Allow to use a custom class for the chart rendering via the Chart(..., renderer_cls=MyClass) keyword argument (see examples/custom-renderer-class.py for inspiration)
The module is is now PEP 561 compatible, and tested with mypy

Changed

Fixed off-by-one shift when rendering empty lines on the Y-axis (the issue was visible only when the Y-axis was on the left side)

2.5.1 - 2022-10-21

Changed

Allow to pass a blank color to color(), it will return the text unchanged
Refactored price highlights, it should now highlight price that would be hidden by a slightly upper value (like 1.025 being hidden because that exact price is not available, but it is surrounded by 1.02, and 1.03, then it will take the place of 1.02)
Better-looking Y-axis style (when on the left-side: PRICE │― → PRICE ┤, and on the right-side: │― PRICE → ├ PRICE)

2.5.0 - 2022-10-19

Added

Capability to round prices on the Y-axis via Y_AXIS_ROUND_DIR (either down [default], or up), and Y_AXIS_ROUND_MULTIPLIER (0.0 by default, set something like 1 / 0.01 to round price to 2 decimals), constants

Changed

Improve rendering performances by ~60%

2.4.0 - 2022-09-23

Added

Capability to highlight values on the Y-axis using chart.set_highlight()
New colors: blue, cyan, grey, magenta, and white

2.3.0 - 2022-09-23

Added

Capability to display graduations on the right side by setting the constants.Y_AXIS_ON_THE_RIGHT to True

Changed

Fixed a zero division error when no candle volume is set
Chart title is now hidden if it is an empty string

2.2.1 - 2022-08-12

Added

constants.PRECISION, and constants.PRECISION_SMALL to control the number of decimals to keep when formatting numbers with fnum() (defaults to 2, and 4, respectively)
constants.MIN_DIFF_THRESHOLD, and constants.MAX_DIFF_THRESHOLD to control candle top, and bottom, thickness fnum() (defaults to 0.25, and 0.75, respectively)

Changed

Fixed formatting of 1.0 number within fnum()
Fixed imports using isort

2.2.0 - 2022-08-12

Added

Candle.__eq__() to allow comparing candles
Introduced constants.Y_AXIS_SPACING to give control Y-axis spacing between graduations (defaults to 4, reduce to display more graduations, and set a higher number to display less graduations)

Changed

Constant changes are now taken into account in real-time, it allows to tweak the chart appearance after having imported the module
Always show the volume pane when it is enabled

2.1.0 - 2022-07-20

Added

Nice Candle Python representation

Changed

Fixed a zero division error when min, and max, prices are equals inside a same candle (closes #4)
Fixed small numbers display on the Y-axis (closes #5)
Fixed bearish/bullish colors inversion in the volume pane

2.0.0 - 2022-05-22

Changed

Fixed values computation in the info bar by using the whole candle set rather than only the visible one (closes #2)
Changed the Chart.update_candles() behavior: it will update current candles by default, and now accepts a reset=True optional argument to actually erase all previous candles first (closes #3)

1.0.0 - 2022-05-21

Added

First version.