Skip to content

Latest commit

 

History

History
107 lines (59 loc) · 4.03 KB

README.md

File metadata and controls

107 lines (59 loc) · 4.03 KB
Raw

Rotkehlchen

Rotkehlchen is an asset management and accounting application specializing in Crypto assets and aims to also help with tax reporting. It is integrated with multiple exchanges and more will come soon. TODO

Installation

For now only Linux is supported and only installation from source. This will change soon and both other platforms will be supported but also easier to install methods will be provided

Rotkehlchen needs Python3 in order to function.

Linux

Make sure you have node.js and npm. If you don't use your linux distro's package manager to get them.

Get zeromq using the package manager of your distro. For example here is the package in Archlinux and in Ubuntu.

Also get sqlcipher using the package manager of your distro. For example here is the package in Archlinux and in Ubuntu.

Install electron and any other npm dependencies by:

npm install --runtime=electron --target=1.8.4

Create a new virtual environment to install all the python dependencies. If you don't have mkvirtualenv then check how to get it depending on your distribution. Here is a guide for Ubuntu and here is one for ArchLinux.

mkvirtualenv rotkehlchen

Then install all the python requirements by doing:

pip install -r requirements.txt

Now to start the application you need to type npm start.

OSX

NOTE: While possible, the installation on OSX is still unsupported.

The <tldr> version is:

  • install sqlcipher
  • use a virtual env with python 3.6.x
  • make sure pip installed everything it says it installed
  • get your node under control with nvm, i tested 8.9

The following recipe has been tested using Anaconda. VirtualEnv works as well, refer to the documentations of those projects to install and use them.

Rotkehlchen uses an encrypted database called SQLCipher. Before we can proceed, we need to install it. Homebrew makes it simple:

$ brew update && brew install sqlcipher

If you wish to use Conda, use the following commands:

$ brew cask install caskroom/cask/anaconda
$ echo "export PATH=$PATH:/usr/local/anaconda3/bin" >> ~/.bash_profile
$ echo ". /usr/local/anaconda3/etc/profile.d/conda.sh" >> ~/.bash_profile
$ source ~/.bash_profile
$ conda create python=3.6 --name rotkehlchen
$ conda activate rotkehlchen

Before using pip, let´s ensure we have the latest version:

$ pip install --upgrade pip

Install all the requirements:

$ sudo pip install -r requirements.txt

Rotkehlchen uses electron, we need to install it:

$ npm install --runtime=electron --target=1.8.4

Almost there, we can now install all the NodeJS dependencies. Using a recent NodeJS version such as 8.9.x, it should be smooth

$ npm install

You now deserved to start Rotkehlchen:

$ npm start

Love it? Want to help?

Contribute

It's an open-source project so help is really appreciated. Open issues, pull requests to help with development, be active in Github and above all be nice.

Get Premium -- Coming Soon

Buy a premium subscription to the software and help us with the development while at the same time enjoying all the cool neat features coming to premium subscribers.

Donate

Don't want or can't afform premium? Still wanna help? We also accept donations.