Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

v1.0.3 #43

Merged
merged 1 commit into from
May 30, 2023
Merged

v1.0.3 #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/coveralls.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,5 @@ jobs:

- name: Send coverage
env:
COVERALLS_TOKEN: ${{secrets.COVERALLS_REPO_TOKEN }}
COVERALLS_TOKEN: ${{secrets.COVERALLS_REPO_TOKEN}}
run: goveralls -coverprofile=profile.cov -service=github
41 changes: 28 additions & 13 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,27 @@
# Changelog

All notable changes to go-nyse-stocks are documented in this file.
All notable changes to this project are documented in this file.

The format is based on [Keep a Changelog], and this project adheres to [Semantic Versioning].

## [Unreleased]

- Will list future updates here

## [1.0.3] - 2023-05-29

### Added

- Added `nyse.png`

### Updated

- Changed name to `stocks-go`

### Removed

- Removed `stocks.png`

## [1.0.2] - 2023-05-24

### Added
Expand All @@ -25,7 +39,7 @@ The format is based on [Keep a Changelog], and this project adheres to [Semantic
- Updated `README.md` to reflect changes.
- Moved `consts.go` to `src` folder.
- Moved `structs.go` to `src` folder.
- Moved and renamed `go-nyse-stocks.go` to `src` folder.
- Moved and renamed `stocks.go` to `src` folder.

## [1.0.1] - 2023-05-23

Expand Down Expand Up @@ -53,7 +67,7 @@ The format is based on [Keep a Changelog], and this project adheres to [Semantic

- Changed `README.md` to reflect changes
- Changed `CHANGELOG.md` to reflect changes
- Change product name to `nyse-go-nyse-stocks`
- Change product name to `nyse-stocks-go`
- Change slug to `nyse_stocks`

## [0.0.5] - 2023-01-18
Expand Down Expand Up @@ -108,13 +122,14 @@ The format is based on [Keep a Changelog], and this project adheres to [Semantic
[Semantic Versioning]: https://semver.org/

<!-- Versions -->
[unreleased]: https://github.com/ggoodwin/go-nyse-stocks/compare/v1.0.2...DEVELOP
[1.0.2]: https://github.com/ggoodwin/go-nyse-stocks/compare/v1.0.1...v1.0.2
[1.0.1]: https://github.com/ggoodwin/go-nyse-stocks/compare/v1.0.0...v1.0.1
[1.0.0]: https://github.com/ggoodwin/go-nyse-stocks/compare/v0.0.6...v1.0.0
[0.0.6]: https://github.com/ggoodwin/go-nyse-stocks/compare/v0.0.5...v0.0.6
[0.0.5]: https://github.com/ggoodwin/go-nyse-stocks/compare/v0.0.4...v0.0.5
[0.0.4]: https://github.com/ggoodwin/go-nyse-stocks/compare/v0.0.3...v0.0.4
[0.0.3]: https://github.com/ggoodwin/go-nyse-stocks/compare/v0.0.2...v0.0.3
[0.0.2]: https://github.com/ggoodwin/go-nyse-stocks/compare/v0.0.1...v0.0.2
[0.0.1]: https://github.com/ggoodwin/go-nyse-stocks/releases/tag/v0.0.1
[unreleased]: https://github.com/ggoodwin/stocks-go/compare/v1.0.3...DEVELOP
[1.0.3]: https://github.com/ggoodwin/stocks-go/compare/v1.0.2...v1.0.3
[1.0.2]: https://github.com/ggoodwin/stocks-go/compare/v1.0.1...v1.0.2
[1.0.1]: https://github.com/ggoodwin/stocks-go/compare/v1.0.0...v1.0.1
[1.0.0]: https://github.com/ggoodwin/stocks-go/compare/v0.0.6...v1.0.0
[0.0.6]: https://github.com/ggoodwin/stocks-go/compare/v0.0.5...v0.0.6
[0.0.5]: https://github.com/ggoodwin/stocks-go/compare/v0.0.4...v0.0.5
[0.0.4]: https://github.com/ggoodwin/stocks-go/compare/v0.0.3...v0.0.4
[0.0.3]: https://github.com/ggoodwin/stocks-go/compare/v0.0.2...v0.0.3
[0.0.2]: https://github.com/ggoodwin/stocks-go/compare/v0.0.1...v0.0.2
[0.0.1]: https://github.com/ggoodwin/stocks-go/releases/tag/v0.0.1
16 changes: 8 additions & 8 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,17 +142,17 @@ Not required, but if you want to include a link to this repo I would greatly app
This guide is based on the **contributing.md**. [Make Your Own]!

<!-- Links -->
[CODE OF CONDUCT]: https://github.com/ggoodwin/go-nyse-stocks/blob/master/CODE_OF_CONDUCT.md
[CODE OF CONDUCT]: https://github.com/ggoodwin/stocks-go/blob/master/CODE_OF_CONDUCT.md
[EMAIL]: mailto:greg@goodwin.id
[DOCUMENTATION]: https://docs.greg.id/go-nyse-stocks
[DOCUMENTATION]: https://pkg.go.dev/github.com/ggoodwin/stocks-go
[MAKE YOUR OWN]: https://contributing.md/
[LICE CAP]: https://www.cockos.com/licecap/
[SILENT CAST]: https://github.com/colinkeenan/silentcast
[BYZANZ]: https://github.com/GNOME/byzanz
[GITHUB ISSUES]: https://github.com/ggoodwin/go-nyse-stocks/issues
[NEW ISSUE]: https://github.com/ggoodwin/go-nyse-stocks/issues/new
[BUG TRACKER]: https://github.com/ggoodwin/go-nyse-stocks/issues?q=label%3Abug
[CONTRIBUTING]: https://github.com/ggoodwin/go-nyse-stocks/blob/master/CONTRIBUTING.md
[FORK]: https://github.com/ggoodwin/go-nyse-stocks/fork
[PULL REQUEST]: https://github.com/ggoodwin/go-nyse-stocks/compare
[GITHUB ISSUES]: https://github.com/ggoodwin/stocks-go/issues
[NEW ISSUE]: https://github.com/ggoodwin/stocks-go/issues/new
[BUG TRACKER]: https://github.com/ggoodwin/stocks-go/issues?q=label%3Abug
[CONTRIBUTING]: https://github.com/ggoodwin/stocks-go/blob/master/CONTRIBUTING.md
[FORK]: https://github.com/ggoodwin/stocks-go/fork
[PULL REQUEST]: https://github.com/ggoodwin/stocks-go/compare
[TELEGRAM]: https://t.me/MessageGreg
36 changes: 18 additions & 18 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<div align="center">
<h1><img alt="go-nyse-stocks logo" src="https://github.com/ggoodwin/go-nyse-stocks/blob/master/stock.png" height="300" /><br />
New York Stock Exchange (NYSE) Go Library
<h1><img alt="stocks-go logo" src="https://github.com/ggoodwin/stocks-go/blob/master/myse.png" height="300" /><br />
Stock Info Go Library
</h1>

<h2>Discord</h2>
Expand All @@ -9,19 +9,19 @@

<h2>Go</h2>

[![Go Reference](https://pkg.go.dev/badge/ggoodwin/go-nyse-stocks.svg)](https://pkg.go.dev/github.com/ggoodwin/go-nyse-stocks) [![Go Version](https://img.shields.io/github/go-mod/go-version/ggoodwin/go-nyse-stocks)](https://go.dev/doc/go1.19)
[![Go Reference](https://pkg.go.dev/badge/ggoodwin/stocks-go.svg)](https://pkg.go.dev/github.com/ggoodwin/stocks-go) [![Go Version](https://img.shields.io/github/go-mod/go-version/ggoodwin/stocks-go)](https://go.dev/doc/go1.19)

<h2>Repo Info</h2>

![Size](https://img.shields.io/github/languages/code-size/ggoodwin/go-nyse-stocks) [![Last Commit](https://img.shields.io/github/last-commit/ggoodwin/go-nyse-stocks)](https://github.com/ggoodwin/go-nyse-stocks/commits/master) [![License](https://img.shields.io/github/license/ggoodwin/go-nyse-stocks)](https://github.com/ggoodwin/go-nyse-stocks/blob/master/LICENSE.md)
![Size](https://img.shields.io/github/languages/code-size/ggoodwin/stocks-go) [![Last Commit](https://img.shields.io/github/last-commit/ggoodwin/stocks-go)](https://github.com/ggoodwin/stocks-go/commits/master) [![License](https://img.shields.io/github/license/ggoodwin/stocks-go)](https://github.com/ggoodwin/stocks-go/blob/master/LICENSE.md)

<h2>Code Reports</h2>

[![GoReportCard](https://goreportcard.com/badge/github.com/ggoodwin/go-nyse-stocks)](https://goreportcard.com/report/github.com/ggoodwin/go-nyse-stocks) [![CodeFactor](https://www.codefactor.io/repository/github/ggoodwin/go-nyse-stocks/badge)](https://www.codefactor.io/repository/github/ggoodwin/go-nyse-stocks) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/17f51d3e54264211b19220ce470783ae)](https://app.codacy.com/gh/ggoodwin/go-nyse-stocks/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [![Coverage Status](https://coveralls.io/repos/github/ggoodwin/go-nyse-stocks/badge.svg?branch=master)](https://coveralls.io/github/ggoodwin/go-nyse-stocks?branch=master)
[![GoReportCard](https://goreportcard.com/badge/github.com/ggoodwin/stocks-go)](https://goreportcard.com/report/github.com/ggoodwin/stocks-go) [![CodeFactor](https://www.codefactor.io/repository/github/ggoodwin/stocks-go/badge)](https://www.codefactor.io/repository/github/ggoodwin/stocks-go) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/17f51d3e54264211b19220ce470783ae)](https://app.codacy.com/gh/ggoodwin/stocks-go/dashboard) [![Coverage Status](https://coveralls.io/repos/github/ggoodwin/stocks-go/badge.svg?branch=master)](https://coveralls.io/github/ggoodwin/stocks-go?branch=master)

<h2>Actions</h2>

[![Go](https://github.com/ggoodwin/go-nyse-stocks/actions/workflows/go.yml/badge.svg?branch=master)](https://github.com/ggoodwin/go-nyse-stocks/actions/workflows/go.yml) [![lint](https://github.com/ggoodwin/go-nyse-stocks/actions/workflows/lint.yml/badge.svg?branch=master)](https://github.com/ggoodwin/go-nyse-stocks/actions/workflows/lint.yml) [![CodeQL](https://github.com/ggoodwin/go-nyse-stocks/actions/workflows/github-code-scanning/codeql/badge.svg?branch=master)](https://github.com/ggoodwin/go-nyse-stocks/actions/workflows/github-code-scanning/codeql) [![Vulnerabilities](https://github.com/ggoodwin/go-nyse-stocks/actions/workflows/vulnerabilities.yml/badge.svg?branch=master)](https://github.com/ggoodwin/go-nyse-stocks/actions/workflows/vulnerabilities.yml) [![Coveralls](https://github.com/ggoodwin/go-nyse-stocks/actions/workflows/coveralls.yml/badge.svg?branch=master)](https://github.com/ggoodwin/go-nyse-stocks/actions/workflows/coveralls.yml)
[![Go](https://github.com/ggoodwin/stocks-go/actions/workflows/go.yml/badge.svg?branch=master)](https://github.com/ggoodwin/stocks-go/actions/workflows/go.yml) [![lint](https://github.com/ggoodwin/stocks-go/actions/workflows/lint.yml/badge.svg?branch=master)](https://github.com/ggoodwin/stocks-go/actions/workflows/lint.yml) [![CodeQL](https://github.com/ggoodwin/stocks-go/actions/workflows/github-code-scanning/codeql/badge.svg?branch=master)](https://github.com/ggoodwin/stocks-go/actions/workflows/github-code-scanning/codeql) [![Vulnerabilities](https://github.com/ggoodwin/stocks-go/actions/workflows/vulnerabilities.yml/badge.svg?branch=master)](https://github.com/ggoodwin/stocks-go/actions/workflows/vulnerabilities.yml) [![Coveralls](https://github.com/ggoodwin/stocks-go/actions/workflows/coveralls.yml/badge.svg?branch=master)](https://github.com/ggoodwin/stocks-go/actions/workflows/coveralls.yml)

</div>
<hr/>
Expand Down Expand Up @@ -49,15 +49,15 @@ If you don't have `Go` installed, you can [Download Go] and install it.
Run the following command in the `console`, in the `project directory`, to install the library with `go get`

```plain
go get github.com/ggoodwin/go-nyse-stocks
go get github.com/ggoodwin/stocks-go
```

### Importing

Add the import to your `.go` file

```go
import "github.com/ggoodwin/go-nyse-stocks"
import "github.com/ggoodwin/stocks-go"
```

## 💰 Usage
Expand All @@ -69,15 +69,15 @@ Add this to your `.go` file
```go
// Parameter: Stock Symbol
// Returns: strings ex: `$123.45`, `1.23%`, `↑`
price, percent, direction := go_nyse_stocks.GetPriceAndPercentage("AAPL")
price, percent, direction := stocks.GetPriceAndPercentage("AAPL")
```

### Get full stock details

```go
// Parameter: Stock Symbol
// Returns `Result` struct
stock := go_nyse_stocks.GetFullDetails("AAPL")
stock := stocks.GetFullDetails("AAPL")
```

### Result struct
Expand Down Expand Up @@ -159,14 +159,14 @@ Check out our [Changelog]
Please read my [Code of Conduct] before contributing or engaging in discussions.

<!-- Links -->
[LICENSE]: https://github.com/ggoodwin/go-nyse-stocks/blob/master/LICENSE.md
[CHANGELOG]: https://github.com/ggoodwin/go-nyse-stocks/blob/master/CHANGELOG.md
[SECURITY]: https://github.com/ggoodwin/go-nyse-stocks/blob/master/SECURITY.md
[FORK]: https://github.com/ggoodwin/go-nyse-stocks/fork
[PULL REQUEST]: https://github.com/ggoodwin/go-nyse-stocks/compare
[CODE OF CONDUCT]: https://github.com/ggoodwin/go-nyse-stocks/blob/master/CODE_OF_CONDUCT.md
[CONTRIBUTING]: https://github.com/ggoodwin/go-nyse-stocks/blob/master/CONTRIBUTING.md
[GITHUB ISSUES]: https://github.com/ggoodwin/go-nyse-stocks/issues
[LICENSE]: https://github.com/ggoodwin/stocks-go/blob/master/LICENSE.md
[CHANGELOG]: https://github.com/ggoodwin/stocks-go/blob/master/CHANGELOG.md
[SECURITY]: https://github.com/ggoodwin/stocks-go/blob/master/SECURITY.md
[FORK]: https://github.com/ggoodwin/stocks-go/fork
[PULL REQUEST]: https://github.com/ggoodwin/stocks-go/compare
[CODE OF CONDUCT]: https://github.com/ggoodwin/stocks-go/blob/master/CODE_OF_CONDUCT.md
[CONTRIBUTING]: https://github.com/ggoodwin/stocks-go/blob/master/CONTRIBUTING.md
[GITHUB ISSUES]: https://github.com/ggoodwin/stocks-go/issues
[YAHOO API]: https://finance.yahoo.com/most-active
[GO]: https://go.dev/
[DOWNLOAD GO]: https://go.dev/dl/
2 changes: 2 additions & 0 deletions TODO.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,6 @@

- [x] Add a `TODO.md` file.
- [x] Update links in markdown to not be so aggressive.
- [x] Change name of package to `stocks-go`
- [ ] Add Tests
- [ ] Audit Security
2 changes: 1 addition & 1 deletion go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
module github.com/ggoodwin/go-nyse-stocks
module github.com/ggoodwin/stocks-go

go 1.19
Binary file added nyse.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed stock.png
View file
Open in desktop
Binary file not shown.
Loading