tulip

command module
v0.9.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 4, 2023 License: MIT Imports: 1 Imported by: 0

README

tulip

Build codecov GitHub go.mod Go version Go Report Card

Extensible market data REST API, made with the intention to interact with multiple market data sources but using the same interface for all.

Running with Yahoo finance as data source

tulip yahoo

Dashboard preview

image-20230112102648846

Components preview

recommendation-trends Peers
Candles heatmap

Extending tulip

To extend tulip you can write your own Source interface implementations, querying for the necessary data sources you need, such as Yahoo finance API...

Documentation

Documentation URL
Components docs/Components.md
OpenAPI docs/api.openapi.yaml
Library https://pkg.go.dev/github.com/shoriwe/tulip
CLI docs/CLI.md
JavaScript client Coming soon...

REST API Clients

Coming soon...

Binaries

You will find pre-build binaries at the release section. If none of these binaries targets your platform use Go command

Docker image

docker pull ghcr.io/shoriwe/tulip:latest

Building from source

Go command
go install github.com/shoriwe/tulip@latest
Local build
git clone https://github.com/shoriwe/tulip
cd tulip
mkdir -p bin && go build -o bin/ .
Docker image
git clone https://github.com/shoriwe/tulip
cd tulip
docker build -t tulip .

Contributing

Consider giving this repository a star if it was useful to you.

  • Contributions are always welcome check CONTRIBUTING.md for more information.

  • If you have any new idea you can open an Issue and I will try my best to make it available in the project.

  • If you have code ready to merge please create a PR.

Coverage

coverage-graph

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL