https://github.com/e257-fi/tackler-ng

Tackler-NG is rusty version of Tackler. It's accounting engine and reporting tool for text based double entry accounting system.
https://github.com/e257-fi/tackler-ng

accounting git ledger plaintext plaintext-accounting rust

Last synced: 2 months ago
JSON representation

Tackler-NG is rusty version of Tackler. It's accounting engine and reporting tool for text based double entry accounting system.

• Host: GitHub
• URL: https://github.com/e257-fi/tackler-ng
• Owner: e257-fi
• License: apache-2.0
• Created: 2023-04-07T06:30:04.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-11-01T18:48:11.000Z (2 months ago)
• Last Synced: 2024-11-01T19:29:36.528Z (2 months ago)
• Topics: accounting, git, ledger, plaintext, plaintext-accounting, rust
• Language: Rust
• Homepage: https://tackler.e257.fi/
• Size: 608 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.adoc
  • Changelog: CHANGELOG.adoc
  • Contributing: CONTRIBUTING.adoc
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

• fucking-awesome-rust - e257-fi/tackler-ng - Fast, reliable bookkeeping engine with native GIT SCM support for plain text accounting [](https://github.com/e257-fi/tackler-ng/blob/main/.github/workflows/ci.yml) (Applications / Finance)
• awesome-rust - e257-fi/tackler-ng - Fast, reliable bookkeeping engine with native GIT SCM support for plain text accounting [](https://github.com/e257-fi/tackler-ng/blob/main/.github/workflows/ci.yml) (Applications / Finance)

README

        
image:https://tackler.e257.fi/img/tackler-ng.svg["crates.io: tackler", link="https://crates.io/crates/tackler"]

image:https://tackler.e257.fi/img/badge-matrix.svg["matrix: tackler", link="https://matrix.to/#/#tackler:matrix.org"]

= Tackler-NG

Tackler-NG is rusty version of link:https://tackler.e257.fi/[Tackler].

And what is Tackler? Tackler is an accounting engine and reporting tool for

link:http://plaintextaccounting.org/[text based double-entry accounting] records.

See link:https://tackler.e257.fi/[Tackler's website] for more information about Tackler and its usage.

[NOTE]

====

Tackler Ain't Calculator and Kernel for link:http://ledger-cli.org/[Ledger] Equivalent Records. +

Why not? -- Because it uses simplified Ledger syntax.

====

== Project Status

The project is in Technology Preview Release phase of the rusty Tackler.

The link:https://tackler.e257.fi/docs/journal/format/[Tackler Journal Format] is fully

supported, as are all transaction backends (link:https://tackler.e257.fi/docs/usage/#storage-selector[Filesystem]

and link:https://tackler.e257.fi/docs/journal/git-storage/[Git Storage]). See `tackler --help` how to use these.

All reports and exports are supported:

* Reports

  ** link:https://tackler.e257.fi/docs/report-balance/[Balance]

  ** link:https://tackler.e257.fi/docs/report-balance-group/[Balance Group]

  ** link:https://tackler.e257.fi/docs/report-register/[Register]

* Exports

  ** link:https://tackler.e257.fi/docs/export-equity/[Equity]

  ** link:https://tackler.e257.fi/docs/export-equity/[Identity]

Other supported notable features are:

* Handling link:https://tackler.e257.fi/docs/commodities/[Commodities] and link:https://tackler.e257.fi/docs/currencies/[Shares]

* link:https://tackler.e257.fi/docs/txn-filters/[Transaction Filters]

* link:https://tackler.e257.fi/docs/gis/txn-geo-location[Transacation Geo Location] and link:https://tackler.e257.fi/docs/gis/txn-geo-filters/[Transaction Geo Filters]

[IMPORTANT]

====

**AS THIS IS TECHNOLOGY PREVIEW RELEASE, THERE ARE MISSING FEATURES

AND KNOWN INCONSISTENCIES WITH EXISTING TACKLER IMPLEMENTATION.**

====

== How to build Tackler CLI application

To build rusty Tackler, you will need git and Rust installed on your environment.

If you don't have Rust installed in your system, get it:

----

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

----

Then get the source code and test vectors:

----

git clone --recurse-submodules https://github.com/e257-fi/tackler-ng

----

And build the Tackler binary:

----

cd tackler-ng

# Check the latest relase version

git tag -l

# Get the release, e.g. v24.11.0

git checkout v24.11.0

# Build tackler

cargo build --release --bin tackler

----

The final binary will be located at `target/release/tackler`.

Optionall, you can also install tackler:

----

cargo install --path tackler-cli --bin tackler

----

You can check that the version of source code and the version of binary match:

----

# Show commit id of source code

git show --oneline --no-patch

# Print build info

target/release/tackler --version

# Or if you installed tackler

tackler --version

----

See `tackler --help`, link:docs/examples.adoc[examples] and tackler-cli crate's link:tackler-cli/CRATES.md[README]

how to use the rusty version of tackler.

link:docs/devel/readme.adoc[Developer's Guides] have technical information about Tackler-NG.

For general information about Tackler, see the original link:https://tackler.e257.fi/docs/[Tackler Documentation].

== Credits

See link:CREDITS.adoc[CREDITS] for full list of credits.

== Security

If you find a security issue in Tackler-NG, please report it as outlined in

link:./SECURITY.md[Security Policy].

== License

....

Copyright 2016-2024 E257.FI Contributors

Licensed under the Apache License, Version 2.0 (the "License");

you may not use this file except in compliance with the License.

You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software

distributed under the License is distributed on an "AS IS" BASIS,

WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

See the License for the specific language governing permissions and

limitations under the License.

....