Tackler is accounting engine and reporting tool for text based double-entry accounting.
Scala Shell ANTLR Other
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
api/src/main/scala/fi/sn127/tackler/api
cli
core
docs
perf
project
tests
todo
tools/generator
.gitignore
.travis.yml
CHANGELOG.adoc
CONTRIBUTING.adoc
DCO
LICENSE
NOTICE
README.adoc
THANKS.adoc
build.sbt
sonatype.sbt

README.adoc

Gitter Build Status Build Status Maven Central javadoc Scala.js

Tackler

Tackler Ain’t Calculator and Kernel for Ledger Equivalent Records. Why not? - Because it uses simplified Ledger syntax.

So in other words, Tackler is accounting engine and reporting tool for text based double-entry accounting.

Features

Why Tackler?

Tackler’s idea is provide concise, minimal and reliable engine to process text-based human readable accounting records.

Concise means that Tackler’s journal format is semantically concise and easy for humans to reason about.

Minimal means that Tackler provides minimum set of features which are needed for its operation.

Reliable means that Tackler’s behaviour is well known, tested and it is documented.

All that said, Tackler can be used easily from command line with normal personal accounting data sets.

Tackler Goals

  • Minimal feature set, very simple and well defined input format

    • Tackler input journal is supposed to be produced by software and to be audited by human. However, it must be possible to edit the journal by hand.

  • Well known and defined behaviour

  • Extensive user and developer documentation

  • Error free, reliable and resilient

    • Near perfect code and permutation test coverage

  • Good performance

    • Must be able to process hundreds of thousands of records with reasonable processing time and memory footprint

    • Must have linear processing time characteristics

    • Assumption: All transactions can be held in memory

  • Provides backend and core components for text based accounting processing

  • JVM and Multi platform support: Linux and Arm-Linux, it should be possible to run it on Windows

  • GIT is used for data distribution and storage

Implementation language of Tackler is Scala and journal parsing is done with ANTLR4.

Todo, TEPs and Roadmap

At the moment, current set of active todo items is kept todo files.

There are Tackler Enhancement Proposals for planning and tracking implementation of major new features. These are listed on TEP index.

Roadmap

Extremely loosely defined roadmap is following:

  • Reporting Server as separate project

  • Transaction filtering

  • Extending support for Units

  • Profit and Loss (PnL) tracking

    • Automatic conversions between different base units

    • Support for unit handling with commodities

  • Extending support for Currencies and Commodities

    • Price database

Releases

For release information and version history details, see CHANGELOG.

Tackler-core is supposed to be usable as separate component. Tackler-api is released for JVM and JS environments, and it is intended to be used on the client side. See Server API and Client API for additional information.

Dependency settings for SBT are:

libraryDependencies += "fi.sn127" %%  "tackler-core" % "version-number"
libraryDependencies += "fi.sn127" %%% "tackler-api"  % "version-number"

These are released on Maven Central Repository.

Tackler is under development, so if you enjoy calm seas then it might be better to look something else.

However, complex backward non-compatible changes to Journal file format should be rare. At the moment Tackler is used in production for operational data set.

Configuration files, command line interface and Client API (data models) are more likely to subject of change.

Contributing to Tackler

Contributions to the project are most welcome. See CONTRIBUTING how you could help.

Your pull requests can be merged only if you can certify the Developer Certificate of Origin (DCO), Version 1.1. To certify DCO (e.g. sign-off your commit), you must add a Signed-off-by line to every git commit message (e.g. by using git commit -s):

Signed-off-by: github-account <your.real@email.address>

If you set your user.name and user.email in git config, then git will include that line for you with git commit -s. These settings can be done per repository basis, so they don’t have be global settings in your system.

Please make sure that you sign-off all your PR’s commits.

Credits

See THANKS for full list of credits.

License

Copyright 2016-2018 SN127.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.