kingchencandGitHub
b06ce2678a
## Problem
Plain `go get` + `go build` of the Go binding never worked **as a dependency**:
- cgo `CFLAGS` pointed at `${SRCDIR}/../c/include` — the parent dir is **outside** the Go module, so a proxy-fetched module has no header.
- the library under `./lib` was git-ignored and never shipped; the README told users to `cargo build` it from the workspace, which only works inside a clone, not from the read-only module cache.
cgo has no build hook and Go has no registry, so the only way a consumer's `go get`+build can find the lib is for it to be committed **inside the module the consumer pulls**. Per the design decision, that module is a separate **`wickra-go`** repo (keeps this repo free of committed binaries), populated by the release pipeline — this PR is the in-repo restructure that makes that possible.
## Changes
- **Vendor the header** at `bindings/go/include/wickra.h` (committed copy of `bindings/c/include/wickra.h`); `CFLAGS` → `-I${SRCDIR}/include`. A **CI drift check** fails if the copy goes stale.
- **Per-platform libraries**: cgo `LDFLAGS` become per `GOOS`/`GOARCH`, linking `${SRCDIR}/lib/<goos>_<goarch>/`.
- **CI** stages the host library into `lib/<goos>_<goarch>/` (`RUNNER_OS`/`RUNNER_ARCH` — note `macos-latest` is arm64) and exports `WICKRA_GO_LIBDIR` for the Windows PATH; libraries stay git-ignored here.
- **README**: install via the `wickra-go` module + a contributor build section.
## Validation
- Local **windows/amd64**: `gofmt` clean, `go vet`, `go build`, `go test` all green against the staged library + vendored header.
- Linux/macOS arches → the 3-OS `Go on …` CI job.
Follow-up (Stage 2, separate): create `wickra-lib/wickra-go` + a `release.yml` mirror job (source + 6 platform libs → `lib/<goos>_<goarch>/`, commit + tag), and point the docs at the new import path. Part of the self-contained gap (`todo-11`).
115 lines
4.5 KiB
Markdown
115 lines
4.5 KiB
Markdown
# Wickra — Go
|
|
|
|
[](https://github.com/wickra-lib/wickra/actions/workflows/ci.yml)
|
|
[](https://codecov.io/gh/wickra-lib/wickra)
|
|
[](https://pkg.go.dev/github.com/wickra-lib/wickra/bindings/go)
|
|
[](https://github.com/wickra-lib/wickra#license)
|
|
|
|
**Streaming-first technical indicators for Go, over the Wickra C ABI hub via cgo.**
|
|
|
|
Wickra is a multi-language technical-analysis library with a Rust core and
|
|
bindings for Python, Node.js and WebAssembly, plus a C ABI for C/C++, C#, Go, Java, R and
|
|
any other C-capable language. Every indicator is an O(1) streaming state machine,
|
|
so live trading bots and historical backtests share the exact same
|
|
implementation. This package is the Go binding; it consumes the C ABI hub through
|
|
cgo and exposes all 514 streaming-first indicators as idiomatic types.
|
|
|
|
## Install
|
|
|
|
Use the published **`wickra-go`** module, which bundles the prebuilt C ABI
|
|
library for every platform, so `go get` + `go build` works with no extra steps
|
|
(a C compiler is still required, as the binding uses cgo):
|
|
|
|
```bash
|
|
go get github.com/wickra-lib/wickra-go
|
|
```
|
|
|
|
```go
|
|
import wickra "github.com/wickra-lib/wickra-go"
|
|
```
|
|
|
|
`wickra-go` is generated from this directory by the release pipeline: it mirrors
|
|
the Go sources, the vendored C ABI header (`include/wickra.h`) and the prebuilt
|
|
libraries under `lib/<goos>_<goarch>/`. On Linux/macOS the library path is baked
|
|
in via rpath; on Windows the DLL must be discoverable at run time (next to the
|
|
executable or on `PATH`).
|
|
|
|
### Building from this repository (contributors)
|
|
|
|
This `bindings/go` directory is the development source. To build it directly,
|
|
compile the C ABI and stage the library into the per-platform directory cgo
|
|
links against:
|
|
|
|
```bash
|
|
cargo build -p wickra-c --release
|
|
mkdir -p bindings/go/lib/linux_amd64 # match your GOOS_GOARCH
|
|
cp target/release/libwickra.so bindings/go/lib/linux_amd64/ # Linux
|
|
cp target/release/libwickra.dylib bindings/go/lib/darwin_arm64/ # macOS (arm64)
|
|
cp target/release/wickra.dll bindings/go/lib/windows_amd64/ # Windows
|
|
```
|
|
|
|
## Quick start
|
|
|
|
```go
|
|
package main
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
wickra "github.com/wickra-lib/wickra/bindings/go"
|
|
)
|
|
|
|
func main() {
|
|
// Batch: run an indicator over a whole series (NaN at warmup positions).
|
|
prices := make([]float64, 1000)
|
|
for i := range prices {
|
|
prices[i] = 100.0 + float64(i)*0.1
|
|
}
|
|
sma, _ := wickra.NewSma(20)
|
|
defer sma.Close()
|
|
values := sma.Batch(prices)
|
|
|
|
// Streaming: the same indicator, fed tick by tick in O(1).
|
|
rsi, _ := wickra.NewRsi(14)
|
|
defer rsi.Close()
|
|
for _, price := range prices {
|
|
value := rsi.Update(price) // NaN during warmup, no recomputation
|
|
if value > 70 {
|
|
fmt.Println("overbought")
|
|
}
|
|
}
|
|
_ = values
|
|
}
|
|
```
|
|
|
|
`Batch(prices)` and feeding the same prices through `Update()` produce identical
|
|
values — the equivalence is enforced by the test suite. Multi-output indicators
|
|
(MACD, Bollinger, ADX, …) return `(Output, bool)`, with `false` while warming up.
|
|
Every indicator owns a native handle freed by `Close()`; a finalizer is wired as
|
|
a backstop, but call `Close()` (e.g. with `defer`) to release memory promptly.
|
|
|
|
## Documentation
|
|
|
|
The full indicator catalogue, guides, quickstarts, and API reference live in the
|
|
main repository and documentation site:
|
|
|
|
- **Repository & full indicator list:** <https://github.com/wickra-lib/wickra>
|
|
- **Docs** (quickstarts, cookbook, TA-Lib migration): <https://docs.wickra.org>
|
|
- **Runnable examples:** [`examples/go/`](https://github.com/wickra-lib/wickra/tree/main/examples/go)
|
|
|
|
Wickra ships native bindings for Python, Node.js, WebAssembly and Rust, plus a
|
|
C ABI hub that any C-capable language (C, C++, C#, Go, Java, R) links against —
|
|
all exposing the same indicators from the shared, `unsafe`-forbidden Rust core.
|
|
|
|
## Disclaimer
|
|
|
|
Wickra is an indicator toolkit, not a trading system. The values it computes are
|
|
deterministic transforms of the input data — they are not financial advice and
|
|
do not predict the market. Any use in a live trading context is at your own risk.
|
|
The library is provided **as is**, without warranty of any kind.
|
|
|
|
## License
|
|
|
|
Licensed under either of [Apache-2.0](https://github.com/wickra-lib/wickra/blob/main/LICENSE-APACHE)
|
|
or [MIT](https://github.com/wickra-lib/wickra/blob/main/LICENSE-MIT) at your option.
|