nasdaq 0.3.0.rc1 → 0.3.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +2 -1
- data/lib/nasdaq/api.rb +2 -2
- data/lib/nasdaq/docopt.txt +68 -68
- data/lib/nasdaq/version.rb +1 -1
- metadata +15 -9
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1f514a80e0562cad74c3d63c8d879df26e9c357239800c1a49e3c36578737de3
|
4
|
+
data.tar.gz: c25d5410a20c10ec48c104ec9cd5d633bc108e0830f347003880d8a511ccb648
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: e23637e33106278505a855fdb6275af0603728baec8463481a2b22ad13a7b093e08fda9c07f7b6fd8ddf12e72df6354ed8226600e0f91694fd038809195cd11a
|
7
|
+
data.tar.gz: c88ec7ddf8e9bd08dba3ad1aa62b2c81bf6373c9cd22082a14057bc46796ab8e8f1c3b88e2acf1bdf7408dfa3203a3792f31c2ee5a556593f3517b2934663aba
|
data/README.md
CHANGED
@@ -2,6 +2,7 @@
|
|
2
2
|
|
3
3
|
[![Gem Version](https://badge.fury.io/rb/nasdaq.svg)](https://badge.fury.io/rb/nasdaq)
|
4
4
|
[![Build Status](https://github.com/DannyBen/nasdaq/workflows/Test/badge.svg)](https://github.com/DannyBen/nasdaq/actions?query=workflow%3ATest)
|
5
|
+
[![Maintainability](https://api.codeclimate.com/v1/badges/1d68eed3be3481f48066/maintainability)](https://codeclimate.com/github/DannyBen/nasdaq/maintainability)
|
5
6
|
|
6
7
|
---
|
7
8
|
|
@@ -214,7 +215,7 @@ $ nasdaq get datasets/WIKI/AAPL
|
|
214
215
|
|
215
216
|
## Command Line Demo
|
216
217
|
|
217
|
-
![Demo](https://raw.githubusercontent.com/DannyBen/nasdaq/master/demo.gif "Demo")
|
218
|
+
![Demo](https://raw.githubusercontent.com/DannyBen/nasdaq/master/support/demo/cast.gif "Demo")
|
218
219
|
|
219
220
|
[1]: https://docs.data.nasdaq.com/docs/getting-started
|
220
221
|
[2]: https://github.com/DannyBen/nasdaq/blob/master/lib/nasdaq/docopt.txt
|
data/lib/nasdaq/api.rb
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
require 'apicake'
|
2
2
|
|
3
3
|
module Nasdaq
|
4
|
-
# Provides access to all the
|
4
|
+
# Provides access to all the API endpoints
|
5
5
|
class API < APICake::Base
|
6
6
|
base_uri 'https://data.nasdaq.com/api/v3'
|
7
7
|
|
@@ -22,7 +22,7 @@ module Nasdaq
|
|
22
22
|
end
|
23
23
|
|
24
24
|
# Returns a hash that will be merged into all query strings before
|
25
|
-
# sending the request
|
25
|
+
# sending the request. This method is used by API Cake.
|
26
26
|
def default_query
|
27
27
|
{ api_key: api_key }
|
28
28
|
end
|
data/lib/nasdaq/docopt.txt
CHANGED
@@ -1,68 +1,68 @@
|
|
1
|
-
Nasdaq Data Link
|
2
|
-
|
3
|
-
Usage:
|
4
|
-
nasdaq get [--csv] PATH [PARAMS...]
|
5
|
-
nasdaq pretty PATH [PARAMS...]
|
6
|
-
nasdaq see PATH [PARAMS...]
|
7
|
-
nasdaq url PATH [PARAMS...]
|
8
|
-
nasdaq save [--csv] FILE PATH [PARAMS...]
|
9
|
-
nasdaq (-h|--help|--version)
|
10
|
-
|
11
|
-
Commands:
|
12
|
-
get
|
13
|
-
Downloads data and prints it to screen as it.
|
14
|
-
|
15
|
-
pretty
|
16
|
-
Downloads data and prints it as a prettified JSON output.
|
17
|
-
|
18
|
-
see
|
19
|
-
Downloads data and prints it with a colored output.
|
20
|
-
|
21
|
-
url
|
22
|
-
Shows the URL constructed from the request.
|
23
|
-
|
24
|
-
save
|
25
|
-
Downloads data and saves it to a file.
|
26
|
-
|
27
|
-
Parameters:
|
28
|
-
PATH:
|
29
|
-
This is the Nasdaq Data Link API path without the query string.
|
30
|
-
For example: datasets/WIKI/AAPL.
|
31
|
-
|
32
|
-
PARAMS:
|
33
|
-
An optional list of query string parameters, separated by a space, to
|
34
|
-
send with the request. Each parameter should be in the format of
|
35
|
-
key:value, for example: page:2 per_page:10
|
36
|
-
|
37
|
-
FILE:
|
38
|
-
Path to the output file.
|
39
|
-
|
40
|
-
Flags:
|
41
|
-
--csv
|
42
|
-
When this flag is provided, the data will be converted to CSV before
|
43
|
-
it is displayed or saved. Note that this works only with endpoints that
|
44
|
-
have a 'data' attribute.
|
45
|
-
|
46
|
-
Environment Variables:
|
47
|
-
NASDAQ_KEY=y0urAP1k3y
|
48
|
-
Set Your Nasdaq Data Link API key. This variable is optional.
|
49
|
-
|
50
|
-
NASDAQ_CACHE_LIFE=360
|
51
|
-
Set the number of seconds to consider the cache fresh. This variable
|
52
|
-
it optional.
|
53
|
-
|
54
|
-
NASDAQ_CACHE_DIR=./cache
|
55
|
-
Set the cache directory. This variable is optional.
|
56
|
-
If both NASDAQ_CACHE_DIR and NASDAQ_CACHE_LIFE are not set, requests
|
57
|
-
will not be cached.
|
58
|
-
|
59
|
-
Examples:
|
60
|
-
nasdaq get databases per_page:2
|
61
|
-
nasdaq get datasets/WIKI/AAPL
|
62
|
-
nasdaq get --csv datasets/WIKI/AAPL rows:5
|
63
|
-
nasdaq get datasets source_code:WIKI query:*
|
64
|
-
nasdaq get datasets query:oil
|
65
|
-
nasdaq url datasets/WIKI/AAPL rows:5
|
66
|
-
nasdaq save --csv output.csv datasets/WIKI/AAPL rows:5
|
67
|
-
nasdaq save output.json datasets/WIKI/AAPL rows:5
|
68
|
-
nasdaq pretty datasets "query:qqq index" per_page:2
|
1
|
+
Nasdaq Data Link
|
2
|
+
|
3
|
+
Usage:
|
4
|
+
nasdaq get [--csv] PATH [PARAMS...]
|
5
|
+
nasdaq pretty PATH [PARAMS...]
|
6
|
+
nasdaq see PATH [PARAMS...]
|
7
|
+
nasdaq url PATH [PARAMS...]
|
8
|
+
nasdaq save [--csv] FILE PATH [PARAMS...]
|
9
|
+
nasdaq (-h|--help|--version)
|
10
|
+
|
11
|
+
Commands:
|
12
|
+
get
|
13
|
+
Downloads data and prints it to screen as it.
|
14
|
+
|
15
|
+
pretty
|
16
|
+
Downloads data and prints it as a prettified JSON output.
|
17
|
+
|
18
|
+
see
|
19
|
+
Downloads data and prints it with a colored output.
|
20
|
+
|
21
|
+
url
|
22
|
+
Shows the URL constructed from the request.
|
23
|
+
|
24
|
+
save
|
25
|
+
Downloads data and saves it to a file.
|
26
|
+
|
27
|
+
Parameters:
|
28
|
+
PATH:
|
29
|
+
This is the Nasdaq Data Link API path without the query string.
|
30
|
+
For example: datasets/WIKI/AAPL.
|
31
|
+
|
32
|
+
PARAMS:
|
33
|
+
An optional list of query string parameters, separated by a space, to
|
34
|
+
send with the request. Each parameter should be in the format of
|
35
|
+
key:value, for example: page:2 per_page:10
|
36
|
+
|
37
|
+
FILE:
|
38
|
+
Path to the output file.
|
39
|
+
|
40
|
+
Flags:
|
41
|
+
--csv
|
42
|
+
When this flag is provided, the data will be converted to CSV before
|
43
|
+
it is displayed or saved. Note that this works only with endpoints that
|
44
|
+
have a 'data' attribute.
|
45
|
+
|
46
|
+
Environment Variables:
|
47
|
+
NASDAQ_KEY=y0urAP1k3y
|
48
|
+
Set Your Nasdaq Data Link API key. This variable is optional.
|
49
|
+
|
50
|
+
NASDAQ_CACHE_LIFE=360
|
51
|
+
Set the number of seconds to consider the cache fresh. This variable
|
52
|
+
it optional.
|
53
|
+
|
54
|
+
NASDAQ_CACHE_DIR=./cache
|
55
|
+
Set the cache directory. This variable is optional.
|
56
|
+
If both NASDAQ_CACHE_DIR and NASDAQ_CACHE_LIFE are not set, requests
|
57
|
+
will not be cached.
|
58
|
+
|
59
|
+
Examples:
|
60
|
+
nasdaq get databases per_page:2
|
61
|
+
nasdaq get datasets/WIKI/AAPL
|
62
|
+
nasdaq get --csv datasets/WIKI/AAPL rows:5
|
63
|
+
nasdaq get datasets source_code:WIKI query:*
|
64
|
+
nasdaq get datasets query:oil
|
65
|
+
nasdaq url datasets/WIKI/AAPL rows:5
|
66
|
+
nasdaq save --csv output.csv datasets/WIKI/AAPL rows:5
|
67
|
+
nasdaq save output.json datasets/WIKI/AAPL rows:5
|
68
|
+
nasdaq pretty datasets "query:qqq index" per_page:2
|
data/lib/nasdaq/version.rb
CHANGED
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: nasdaq
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.3.
|
4
|
+
version: 0.3.1
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Danny Ben Shitrit
|
8
|
-
autorequire:
|
8
|
+
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2024-02-23 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: apicake
|
@@ -17,6 +17,9 @@ dependencies:
|
|
17
17
|
- - "~>"
|
18
18
|
- !ruby/object:Gem::Version
|
19
19
|
version: '0.1'
|
20
|
+
- - ">="
|
21
|
+
- !ruby/object:Gem::Version
|
22
|
+
version: 0.1.6
|
20
23
|
type: :runtime
|
21
24
|
prerelease: false
|
22
25
|
version_requirements: !ruby/object:Gem::Requirement
|
@@ -24,6 +27,9 @@ dependencies:
|
|
24
27
|
- - "~>"
|
25
28
|
- !ruby/object:Gem::Version
|
26
29
|
version: '0.1'
|
30
|
+
- - ">="
|
31
|
+
- !ruby/object:Gem::Version
|
32
|
+
version: 0.1.6
|
27
33
|
- !ruby/object:Gem::Dependency
|
28
34
|
name: lp
|
29
35
|
requirement: !ruby/object:Gem::Requirement
|
@@ -75,7 +81,7 @@ metadata:
|
|
75
81
|
changelog_uri: https://github.com/DannyBen/nasdaq/blob/master/CHANGELOG.md
|
76
82
|
source_code_uri: https://github.com/DannyBen/nasdaq
|
77
83
|
rubygems_mfa_required: 'true'
|
78
|
-
post_install_message:
|
84
|
+
post_install_message:
|
79
85
|
rdoc_options: []
|
80
86
|
require_paths:
|
81
87
|
- lib
|
@@ -83,15 +89,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
|
|
83
89
|
requirements:
|
84
90
|
- - ">="
|
85
91
|
- !ruby/object:Gem::Version
|
86
|
-
version: '
|
92
|
+
version: '3.1'
|
87
93
|
required_rubygems_version: !ruby/object:Gem::Requirement
|
88
94
|
requirements:
|
89
|
-
- - "
|
95
|
+
- - ">="
|
90
96
|
- !ruby/object:Gem::Version
|
91
|
-
version:
|
97
|
+
version: '0'
|
92
98
|
requirements: []
|
93
|
-
rubygems_version: 3.
|
94
|
-
signing_key:
|
99
|
+
rubygems_version: 3.5.6
|
100
|
+
signing_key:
|
95
101
|
specification_version: 4
|
96
102
|
summary: Nasdaq Data Link API Library and Command Line
|
97
103
|
test_files: []
|