Skip to content

Commit 6ce5595

Browse files
committed
modify
1 parent bb850ea commit 6ce5595

29 files changed

+131
-84
lines changed

README.md

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# finance-go
22

3-
[![GoDoc](http://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/piquette/finance-go) [![Build Status](https://travis-ci.org/piquette/finance-go.svg?branch=master)](https://travis-ci.org/piquette/finance-go) [![Coverage Status](https://coveralls.io/repos/github/piquette/finance-go/badge.svg?branch=master)](https://coveralls.io/github/piquette/finance-go?branch=master)
3+
[![GoDoc](http://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/TraderWithPython/finance-go) [![Build Status](https://travis-ci.org/piquette/finance-go.svg?branch=master)](https://travis-ci.org/piquette/finance-go) [![Coverage Status](https://coveralls.io/repos/github/piquette/finance-go/badge.svg?branch=master)](https://coveralls.io/github/piquette/finance-go?branch=master)
44

55
## Summary
66

@@ -10,19 +10,19 @@ Check out the [qtrn cli application][qtrn], which is intended as a living exampl
1010

1111
### Features
1212

13-
Description | Source
14-
--- | ---
15-
Quote(s) | Yahoo finance
16-
Equity quote(s) | Yahoo finance
17-
Index quote(s) | Yahoo finance
18-
Option quote(s) | Yahoo finance
19-
Forex pair quote(s) | Yahoo finance
20-
Cryptocurrency pair quote(s) | Yahoo finance
21-
Futures quote(s) | Yahoo finance
22-
ETF quote(s) | Yahoo finance
23-
Mutual fund quote(s) | Yahoo finance
24-
Historical quotes | Yahoo finance
25-
Options straddles | Yahoo finance
13+
| Description | Source |
14+
| ---------------------------- | ------------- |
15+
| Quote(s) | Yahoo finance |
16+
| Equity quote(s) | Yahoo finance |
17+
| Index quote(s) | Yahoo finance |
18+
| Option quote(s) | Yahoo finance |
19+
| Forex pair quote(s) | Yahoo finance |
20+
| Cryptocurrency pair quote(s) | Yahoo finance |
21+
| Futures quote(s) | Yahoo finance |
22+
| ETF quote(s) | Yahoo finance |
23+
| Mutual fund quote(s) | Yahoo finance |
24+
| Historical quotes | Yahoo finance |
25+
| Options straddles | Yahoo finance |
2626

2727
## Documentation
2828

@@ -35,18 +35,19 @@ For now, for details on all the functionality in this library, see the [GoDoc][g
3535
This project supports modules and Go 1.13+. Add `finance-go` to your own project the usual way -
3636

3737
```sh
38-
go get github.com/piquette/finance-go
38+
go get github.com/TraderWithPython/finance-go
3939
```
4040

4141
## Usage example
4242

4343
Library usage is meant to be very specific about the user's intentions.
4444

4545
### Quote
46+
4647
```go
4748
q, err := quote.Get("AAPL")
4849
if err != nil {
49-
// Uh-oh.
50+
// Uh-oh.
5051
panic(err)
5152
}
5253

@@ -55,10 +56,11 @@ fmt.Println(q)
5556
```
5657

5758
### Equity quote (more fields)
59+
5860
```go
5961
q, err := equity.Get("AAPL")
6062
if err != nil {
61-
// Uh-oh.
63+
// Uh-oh.
6264
panic(err)
6365
}
6466

@@ -67,6 +69,7 @@ fmt.Println(q)
6769
```
6870

6971
### Historical quotes (OHLCV)
72+
7073
```go
7174
params := &chart.Params{
7275
Symbol: "TWTR",
@@ -99,9 +102,11 @@ The test suite needs testify's `require` package to run:
99102
It also depends on a running instance of a test server [finance-mock], so make sure to fetch that project and run the application from another terminal session ([finance-mock's README][finance-mock] contains more information).
100103

101104
### Docker
105+
102106
```sh
103107
docker run -p 12111:12111 piquette/finance-mock:latest
104108
```
109+
105110
### Brew
106111

107112
brew tap piquette/finance-mock
@@ -129,13 +134,14 @@ For any requests, bug or comments, please [open an issue][issues] or [submit a
129134
pull request][pulls]. Also please email or tweet me as needed.
130135

131136
## Notes
137+
132138
- Yahoo changes their finance APIs without warning, which is their right to do so. However, its annoying and leads to some instability in this project..
133139
- Big shoutout to Stripe and the team working on the [stripe-go][stripe] project, I took a lot of library design / implementation hints from them.
134140

135-
[godoc]: http://godoc.org/github.com/piquette/finance-go
136-
[issues]: https://github.com/piquette/finance-go/issues/new
141+
[godoc]: http://godoc.org/github.com/TraderWithPython/finance-go
142+
[issues]: https://github.com/TraderWithPython/finance-go/issues/new
137143
[qtrn]: https://github.com/piquette/qtrn
138-
[pulls]: https://github.com/piquette/finance-go/pulls
144+
[pulls]: https://github.com/TraderWithPython/finance-go/pulls
139145
[finance-mock]: https://github.com/piquette/finance-mock
140146
[stripe]: https://github.com/stripe/stripe-go
141147
[api-docs]: https://piquette.io/projects/finance-go/

chart/client.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@ package chart
33
import (
44
"context"
55

6-
finance "github.com/piquette/finance-go"
7-
"github.com/piquette/finance-go/datetime"
8-
form "github.com/piquette/finance-go/form"
9-
"github.com/piquette/finance-go/iter"
6+
finance "github.com/TraderWithPython/finance-go"
7+
"github.com/TraderWithPython/finance-go/datetime"
8+
form "github.com/TraderWithPython/finance-go/form"
9+
"github.com/TraderWithPython/finance-go/iter"
1010
"github.com/shopspring/decimal"
1111
)
1212

chart/client_test.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ package chart
33
import (
44
"testing"
55

6-
tests "github.com/piquette/finance-go/testing"
6+
tests "github.com/TraderWithPython/finance-go/testing"
77
"github.com/stretchr/testify/assert"
88
)
99

crypto/client.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ import (
44
"context"
55
"strings"
66

7-
finance "github.com/piquette/finance-go"
8-
form "github.com/piquette/finance-go/form"
9-
"github.com/piquette/finance-go/iter"
7+
finance "github.com/TraderWithPython/finance-go"
8+
form "github.com/TraderWithPython/finance-go/form"
9+
"github.com/TraderWithPython/finance-go/iter"
1010
)
1111

1212
// Client is used to invoke quote APIs.

crypto/client_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ package crypto
33
import (
44
"testing"
55

6-
finance "github.com/piquette/finance-go"
7-
tests "github.com/piquette/finance-go/testing"
6+
finance "github.com/TraderWithPython/finance-go"
7+
tests "github.com/TraderWithPython/finance-go/testing"
88
"github.com/stretchr/testify/assert"
99
)
1010

equity/client.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ import (
44
"context"
55
"strings"
66

7-
finance "github.com/piquette/finance-go"
8-
form "github.com/piquette/finance-go/form"
9-
"github.com/piquette/finance-go/iter"
7+
finance "github.com/TraderWithPython/finance-go"
8+
form "github.com/TraderWithPython/finance-go/form"
9+
"github.com/TraderWithPython/finance-go/iter"
1010
)
1111

1212
// Client is used to invoke quote APIs.

equity/client_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ package equity
33
import (
44
"testing"
55

6-
finance "github.com/piquette/finance-go"
7-
tests "github.com/piquette/finance-go/testing"
6+
finance "github.com/TraderWithPython/finance-go"
7+
tests "github.com/TraderWithPython/finance-go/testing"
88
"github.com/stretchr/testify/assert"
99
)
1010

etf/client.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ import (
44
"context"
55
"strings"
66

7-
finance "github.com/piquette/finance-go"
8-
form "github.com/piquette/finance-go/form"
9-
"github.com/piquette/finance-go/iter"
7+
finance "github.com/TraderWithPython/finance-go"
8+
form "github.com/TraderWithPython/finance-go/form"
9+
"github.com/TraderWithPython/finance-go/iter"
1010
)
1111

1212
// Client is used to invoke quote APIs.

etf/client_test.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ package etf
33
import (
44
"testing"
55

6-
finance "github.com/piquette/finance-go"
7-
tests "github.com/piquette/finance-go/testing"
6+
finance "github.com/TraderWithPython/finance-go"
7+
tests "github.com/TraderWithPython/finance-go/testing"
88
"github.com/stretchr/testify/assert"
99
)
1010

examples/main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ package main
33
import (
44
"fmt"
55

6-
"github.com/piquette/finance-go/options"
6+
"github.com/TraderWithPython/finance-go/options"
77
)
88

99
// This file lists several usage examples of this library

0 commit comments

Comments
 (0)