Initial import
This commit is contained in:
commit
7417e2fca4
9 changed files with 332 additions and 0 deletions
2
.gitignore
vendored
Normal file
2
.gitignore
vendored
Normal file
|
@ -0,0 +1,2 @@
|
||||||
|
/lib
|
||||||
|
/bin
|
165
LICENSE
Normal file
165
LICENSE
Normal file
|
@ -0,0 +1,165 @@
|
||||||
|
GNU LESSER GENERAL PUBLIC LICENSE
|
||||||
|
Version 3, 29 June 2007
|
||||||
|
|
||||||
|
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
|
||||||
|
Everyone is permitted to copy and distribute verbatim copies
|
||||||
|
of this license document, but changing it is not allowed.
|
||||||
|
|
||||||
|
|
||||||
|
This version of the GNU Lesser General Public License incorporates
|
||||||
|
the terms and conditions of version 3 of the GNU General Public
|
||||||
|
License, supplemented by the additional permissions listed below.
|
||||||
|
|
||||||
|
0. Additional Definitions.
|
||||||
|
|
||||||
|
As used herein, "this License" refers to version 3 of the GNU Lesser
|
||||||
|
General Public License, and the "GNU GPL" refers to version 3 of the GNU
|
||||||
|
General Public License.
|
||||||
|
|
||||||
|
"The Library" refers to a covered work governed by this License,
|
||||||
|
other than an Application or a Combined Work as defined below.
|
||||||
|
|
||||||
|
An "Application" is any work that makes use of an interface provided
|
||||||
|
by the Library, but which is not otherwise based on the Library.
|
||||||
|
Defining a subclass of a class defined by the Library is deemed a mode
|
||||||
|
of using an interface provided by the Library.
|
||||||
|
|
||||||
|
A "Combined Work" is a work produced by combining or linking an
|
||||||
|
Application with the Library. The particular version of the Library
|
||||||
|
with which the Combined Work was made is also called the "Linked
|
||||||
|
Version".
|
||||||
|
|
||||||
|
The "Minimal Corresponding Source" for a Combined Work means the
|
||||||
|
Corresponding Source for the Combined Work, excluding any source code
|
||||||
|
for portions of the Combined Work that, considered in isolation, are
|
||||||
|
based on the Application, and not on the Linked Version.
|
||||||
|
|
||||||
|
The "Corresponding Application Code" for a Combined Work means the
|
||||||
|
object code and/or source code for the Application, including any data
|
||||||
|
and utility programs needed for reproducing the Combined Work from the
|
||||||
|
Application, but excluding the System Libraries of the Combined Work.
|
||||||
|
|
||||||
|
1. Exception to Section 3 of the GNU GPL.
|
||||||
|
|
||||||
|
You may convey a covered work under sections 3 and 4 of this License
|
||||||
|
without being bound by section 3 of the GNU GPL.
|
||||||
|
|
||||||
|
2. Conveying Modified Versions.
|
||||||
|
|
||||||
|
If you modify a copy of the Library, and, in your modifications, a
|
||||||
|
facility refers to a function or data to be supplied by an Application
|
||||||
|
that uses the facility (other than as an argument passed when the
|
||||||
|
facility is invoked), then you may convey a copy of the modified
|
||||||
|
version:
|
||||||
|
|
||||||
|
a) under this License, provided that you make a good faith effort to
|
||||||
|
ensure that, in the event an Application does not supply the
|
||||||
|
function or data, the facility still operates, and performs
|
||||||
|
whatever part of its purpose remains meaningful, or
|
||||||
|
|
||||||
|
b) under the GNU GPL, with none of the additional permissions of
|
||||||
|
this License applicable to that copy.
|
||||||
|
|
||||||
|
3. Object Code Incorporating Material from Library Header Files.
|
||||||
|
|
||||||
|
The object code form of an Application may incorporate material from
|
||||||
|
a header file that is part of the Library. You may convey such object
|
||||||
|
code under terms of your choice, provided that, if the incorporated
|
||||||
|
material is not limited to numerical parameters, data structure
|
||||||
|
layouts and accessors, or small macros, inline functions and templates
|
||||||
|
(ten or fewer lines in length), you do both of the following:
|
||||||
|
|
||||||
|
a) Give prominent notice with each copy of the object code that the
|
||||||
|
Library is used in it and that the Library and its use are
|
||||||
|
covered by this License.
|
||||||
|
|
||||||
|
b) Accompany the object code with a copy of the GNU GPL and this license
|
||||||
|
document.
|
||||||
|
|
||||||
|
4. Combined Works.
|
||||||
|
|
||||||
|
You may convey a Combined Work under terms of your choice that,
|
||||||
|
taken together, effectively do not restrict modification of the
|
||||||
|
portions of the Library contained in the Combined Work and reverse
|
||||||
|
engineering for debugging such modifications, if you also do each of
|
||||||
|
the following:
|
||||||
|
|
||||||
|
a) Give prominent notice with each copy of the Combined Work that
|
||||||
|
the Library is used in it and that the Library and its use are
|
||||||
|
covered by this License.
|
||||||
|
|
||||||
|
b) Accompany the Combined Work with a copy of the GNU GPL and this license
|
||||||
|
document.
|
||||||
|
|
||||||
|
c) For a Combined Work that displays copyright notices during
|
||||||
|
execution, include the copyright notice for the Library among
|
||||||
|
these notices, as well as a reference directing the user to the
|
||||||
|
copies of the GNU GPL and this license document.
|
||||||
|
|
||||||
|
d) Do one of the following:
|
||||||
|
|
||||||
|
0) Convey the Minimal Corresponding Source under the terms of this
|
||||||
|
License, and the Corresponding Application Code in a form
|
||||||
|
suitable for, and under terms that permit, the user to
|
||||||
|
recombine or relink the Application with a modified version of
|
||||||
|
the Linked Version to produce a modified Combined Work, in the
|
||||||
|
manner specified by section 6 of the GNU GPL for conveying
|
||||||
|
Corresponding Source.
|
||||||
|
|
||||||
|
1) Use a suitable shared library mechanism for linking with the
|
||||||
|
Library. A suitable mechanism is one that (a) uses at run time
|
||||||
|
a copy of the Library already present on the user's computer
|
||||||
|
system, and (b) will operate properly with a modified version
|
||||||
|
of the Library that is interface-compatible with the Linked
|
||||||
|
Version.
|
||||||
|
|
||||||
|
e) Provide Installation Information, but only if you would otherwise
|
||||||
|
be required to provide such information under section 6 of the
|
||||||
|
GNU GPL, and only to the extent that such information is
|
||||||
|
necessary to install and execute a modified version of the
|
||||||
|
Combined Work produced by recombining or relinking the
|
||||||
|
Application with a modified version of the Linked Version. (If
|
||||||
|
you use option 4d0, the Installation Information must accompany
|
||||||
|
the Minimal Corresponding Source and Corresponding Application
|
||||||
|
Code. If you use option 4d1, you must provide the Installation
|
||||||
|
Information in the manner specified by section 6 of the GNU GPL
|
||||||
|
for conveying Corresponding Source.)
|
||||||
|
|
||||||
|
5. Combined Libraries.
|
||||||
|
|
||||||
|
You may place library facilities that are a work based on the
|
||||||
|
Library side by side in a single library together with other library
|
||||||
|
facilities that are not Applications and are not covered by this
|
||||||
|
License, and convey such a combined library under terms of your
|
||||||
|
choice, if you do both of the following:
|
||||||
|
|
||||||
|
a) Accompany the combined library with a copy of the same work based
|
||||||
|
on the Library, uncombined with any other library facilities,
|
||||||
|
conveyed under the terms of this License.
|
||||||
|
|
||||||
|
b) Give prominent notice with the combined library that part of it
|
||||||
|
is a work based on the Library, and explaining where to find the
|
||||||
|
accompanying uncombined form of the same work.
|
||||||
|
|
||||||
|
6. Revised Versions of the GNU Lesser General Public License.
|
||||||
|
|
||||||
|
The Free Software Foundation may publish revised and/or new versions
|
||||||
|
of the GNU Lesser General Public License from time to time. Such new
|
||||||
|
versions will be similar in spirit to the present version, but may
|
||||||
|
differ in detail to address new problems or concerns.
|
||||||
|
|
||||||
|
Each version is given a distinguishing version number. If the
|
||||||
|
Library as you received it specifies that a certain numbered version
|
||||||
|
of the GNU Lesser General Public License "or any later version"
|
||||||
|
applies to it, you have the option of following the terms and
|
||||||
|
conditions either of that published version or of any later version
|
||||||
|
published by the Free Software Foundation. If the Library as you
|
||||||
|
received it does not specify a version number of the GNU Lesser
|
||||||
|
General Public License, you may choose any version of the GNU Lesser
|
||||||
|
General Public License ever published by the Free Software Foundation.
|
||||||
|
|
||||||
|
If the Library as you received it specifies that a proxy can decide
|
||||||
|
whether future versions of the GNU Lesser General Public License shall
|
||||||
|
apply, that proxy's public statement of acceptance of any version is
|
||||||
|
permanent authorization for you to choose that version for the
|
||||||
|
Library.
|
11
Makefile
Normal file
11
Makefile
Normal file
|
@ -0,0 +1,11 @@
|
||||||
|
|
||||||
|
all: build
|
||||||
|
|
||||||
|
build: bin/hodler
|
||||||
|
|
||||||
|
bin/hodler: $(wildcard src/*.cr)
|
||||||
|
shards build hodler
|
||||||
|
|
||||||
|
completion: bin/hodler
|
||||||
|
$< --completion --development
|
||||||
|
|
35
README.md
Normal file
35
README.md
Normal file
|
@ -0,0 +1,35 @@
|
||||||
|
|
||||||
|
# Hodler
|
||||||
|
|
||||||
|
holder is a lightweight interactive terminal based UI application for monitoring your cryptocurrency portfolio in real-time.
|
||||||
|
|
||||||
|
## Features / Roadmap
|
||||||
|
|
||||||
|
* :x: Multiple wallets description
|
||||||
|
* :x: Trade history support (buy date, buy price, now price, amount)
|
||||||
|
* :x: Invest + current wealth + win/loss + percent calculation
|
||||||
|
* :x: Report-mode output
|
||||||
|
* :x: Ncurses output (first read-only, then interactive)
|
||||||
|
* :x: Wallet import (CEX plugins)
|
||||||
|
* :x: Trade history import (CEX plugins)
|
||||||
|
* :x: Real time update
|
||||||
|
|
||||||
|
## Inspirations
|
||||||
|
|
||||||
|
* [cryptop](https://github.com/huwwp/cryptop): Nice ncurses UI. Not support for wallet naming, nor trade history.
|
||||||
|
* [cointop](https://github.com/miguelmota/cointop): Nice ncurses UI & good shortcut keys + README file. Not support for wallet/portfolio.
|
||||||
|
* [coinwatch](https://github.com/cytopia/coinwatch): Good support for trade history. 100% configuration based. Not support for CEX trade import nor interactive UI.
|
||||||
|
* [foxfolio](): Nice GUI & options. Heavy browser-based app, not running in terminal. Still unstable.
|
||||||
|
|
||||||
|
## Tip Jar
|
||||||
|
|
||||||
|
[![BTC Tip Jar](https://img.shields.io/badge/BTC-tip-yellow.svg?logo=bitcoin&style=flat)]() `xxx`
|
||||||
|
|
||||||
|
[![ETH Tip Jar](https://img.shields.io/badge/ETH-tip-blue.svg?logo=ethereum&style=flat)]() `xxx`
|
||||||
|
|
||||||
|
Thank you for tips! :pray:
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Released under the GNU LGPL-3 license.
|
||||||
|
|
10
shard.lock
Normal file
10
shard.lock
Normal file
|
@ -0,0 +1,10 @@
|
||||||
|
version: 2.0
|
||||||
|
shards:
|
||||||
|
completion:
|
||||||
|
git: https://github.com/matiasgarciaisaia/completion.git
|
||||||
|
version: 0.1.0+git.commit.780bab511917b61e7d814801fd9acd4390eda44a
|
||||||
|
|
||||||
|
xdg_basedir:
|
||||||
|
git: https://github.com/shmibs/xdg_basedir.git
|
||||||
|
version: 1.0.2
|
||||||
|
|
31
shard.yml
Normal file
31
shard.yml
Normal file
|
@ -0,0 +1,31 @@
|
||||||
|
---
|
||||||
|
name: hodler
|
||||||
|
version: 0.1.0
|
||||||
|
|
||||||
|
authors:
|
||||||
|
- Glenn Y. Rolland <glenux@glenux.net>
|
||||||
|
|
||||||
|
description: |
|
||||||
|
Crypto-currencies porfolio monitoring tool
|
||||||
|
|
||||||
|
targets:
|
||||||
|
hodler:
|
||||||
|
main: src/main.cr
|
||||||
|
|
||||||
|
dependencies:
|
||||||
|
xdg_basedir:
|
||||||
|
github: shmibs/xdg_basedir
|
||||||
|
completion:
|
||||||
|
github: matiasgarciaisaia/completion
|
||||||
|
branch: crystal-0.18
|
||||||
|
# github: f/completion
|
||||||
|
|
||||||
|
# pg:
|
||||||
|
# github: will/crystal-pg
|
||||||
|
# version: "~> 0.5"
|
||||||
|
|
||||||
|
# development_dependencies:
|
||||||
|
# webmock:
|
||||||
|
# github: manastech/webmock.cr
|
||||||
|
|
||||||
|
license: LGPL-3
|
58
src/cli.cr
Normal file
58
src/cli.cr
Normal file
|
@ -0,0 +1,58 @@
|
||||||
|
|
||||||
|
module Hodler
|
||||||
|
class Cli
|
||||||
|
alias Options = {
|
||||||
|
wallet_file: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
# @config : Config?
|
||||||
|
@options : Options?
|
||||||
|
|
||||||
|
def initialize
|
||||||
|
# @config = nil
|
||||||
|
@options = nil
|
||||||
|
end
|
||||||
|
|
||||||
|
def parse_options(args) : Options
|
||||||
|
# default values
|
||||||
|
wallet_file = XDGBasedir.full_path("hodler/wallet.yml", :config, :read).as(String)
|
||||||
|
|
||||||
|
# parse
|
||||||
|
OptionParser.parse(args) do |parser|
|
||||||
|
parser.banner = "Usage: hodler [arguments]"
|
||||||
|
|
||||||
|
parser.on "-w WALLET_FILE", "--wallet=WALLET_FILE", "Use the following wallet file" do |file|
|
||||||
|
wallet_file = file
|
||||||
|
end
|
||||||
|
|
||||||
|
# parser.on "-f DOCKER_COMPOSE_YML", "--config=DOCKER_COMPOSE_YML", "Use the following docker-compose file" do |file|
|
||||||
|
# docker_compose_yml = file
|
||||||
|
# end
|
||||||
|
|
||||||
|
parser.on "-v", "--version", "Show version" do
|
||||||
|
puts "version #{Version::VERSION}"
|
||||||
|
exit 0
|
||||||
|
end
|
||||||
|
parser.on "-h", "--help", "Show help" do
|
||||||
|
puts parser
|
||||||
|
exit 0
|
||||||
|
end
|
||||||
|
|
||||||
|
complete_with "hodler", parser
|
||||||
|
end
|
||||||
|
|
||||||
|
@options = {
|
||||||
|
wallet_file: wallet_file
|
||||||
|
}
|
||||||
|
|
||||||
|
return @options.as(Options)
|
||||||
|
end
|
||||||
|
|
||||||
|
def self.run(args)
|
||||||
|
app = Cli.new
|
||||||
|
app.parse_options(args)
|
||||||
|
# config = app.load_config(opts["config_file"])
|
||||||
|
# env_config = App.get_config(config, opts["environment"])
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
14
src/main.cr
Normal file
14
src/main.cr
Normal file
|
@ -0,0 +1,14 @@
|
||||||
|
|
||||||
|
require "option_parser"
|
||||||
|
require "yaml"
|
||||||
|
require "colorize"
|
||||||
|
require "xdg_basedir"
|
||||||
|
require "completion"
|
||||||
|
|
||||||
|
# require "./config"
|
||||||
|
require "./version"
|
||||||
|
require "./cli"
|
||||||
|
|
||||||
|
|
||||||
|
Hodler::Cli.run(ARGV)
|
||||||
|
|
6
src/version.cr
Normal file
6
src/version.cr
Normal file
|
@ -0,0 +1,6 @@
|
||||||
|
|
||||||
|
module Hodler
|
||||||
|
class Version
|
||||||
|
VERSION = "0.1.0"
|
||||||
|
end
|
||||||
|
end
|
Loading…
Reference in a new issue