Skip to content

Commit

Permalink
Make the formatter cli deprecated
Browse files Browse the repository at this point in the history
  • Loading branch information
fangpenlin committed Jun 28, 2024
1 parent e15a9bd commit e50a3bb
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 3 deletions.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# beancount-black [![CircleCI](https://circleci.com/gh/LaunchPlatform/beancount-black/tree/master.svg?style=svg)](https://circleci.com/gh/LaunchPlatform/beancount-black/tree/master)
Opinionated code formatter, just like Python's [black](https://pypi.org/project/black/) code formatter but for Beancount
Opinionated Beancount formatter library, just like Python's [black](https://pypi.org/project/black/) code formatter but for Beancount

Try it out online [here](https://app.beanhub.io/tools/beancount-formatter)

Expand Down Expand Up @@ -28,6 +28,13 @@ It would be greatly beneficial for the community to access a tool like this, so

## Install

> [!WARNING]
> Bean-black is deprecated and will remain as is, with no feature updates.
> It's subject to removal in future versions.
> In the future, the `beancount-black` package will focus on serving as a Beancount formatter library.
> Please use [beanhub-cli](https://github.com/LaunchPlatform/beanhub-cli) instead if you need a formatter command-line tool.
> Newer features like file traversal, account, or commodity renaming will only be available with `beanhub-cli`.
To install the formatter, simply run

```bash
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[tool.poetry]
name = "beancount-black"
version = "1.0.2"
description = "Opinioned code formatter, just like Python's black code formatter but for Beancount"
version = "1.0.3"
description = "Opinioned beancount formatter library"
authors = ["Fang-Pen Lin <[email protected]>"]
license = "MIT"
repository = "https://github.com/LaunchPlatform/beancount-black"
Expand Down

0 comments on commit e50a3bb

Please sign in to comment.