nasdaq 0.3.0.rc1 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -0
  3. data/lib/nasdaq/docopt.txt +68 -68
  4. data/lib/nasdaq/version.rb +1 -1
  5. metadata +3 -3
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: aed342089c070709ba3e3ae42d467da76f67428d3323d70c04c5a2c26131be7d
4
- data.tar.gz: c33341051dc44b7351afbe394361c94a8b8d7fa193c1353e77ffff7e5a076de2
3
+ metadata.gz: 23d2a87be7f49a8cf686d947acc2970fa8fbcff84b318cc6b784f48152ba8839
4
+ data.tar.gz: 151de2d4439d47f07bd6018336bbe0788ef9f686052a365bc746e77c460f183d
5
5
  SHA512:
6
- metadata.gz: 4f281cf8f6c899edff90e6ed4f78ff0dda02f0c6b00c41204ffd7db1c2e1388dfc600a30628b69f2c8cabe08e0b885e38d5cebc61cbaa48a649cdbea8de0dac9
7
- data.tar.gz: d4d1d7912ef5f5eeca413b26f37eaac3f1b579b772b3053c294c60c4ca20c602ba1376f22de9e2af88fdd3e324c9a3c7cae25836fbeecada41c0e675978e5780
6
+ metadata.gz: ced8e79b422c4cf766b44c70560a6eb9c25a533345d98c8cbcbb412363ebe79f1a763aef1c1d59a1e7799b2085d8d6a49b3ec9cc42fdad3d71749e16246fabf2
7
+ data.tar.gz: 7a2604a97e4d56e9c5b7a3a95eb566388a31596dedd13cc4c073efc1a0dd7376d41ed43fbf88735445be835bd1ff22e55cdebbe290b503eeab73195034b08fe2
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
 
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
@@ -1,3 +1,3 @@
1
1
  module Nasdaq
2
- VERSION = '0.3.0.rc1'
2
+ VERSION = '0.3.0'
3
3
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: nasdaq
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.0.rc1
4
+ version: 0.3.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Danny Ben Shitrit
@@ -86,9 +86,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
86
86
  version: '2.7'
87
87
  required_rubygems_version: !ruby/object:Gem::Requirement
88
88
  requirements:
89
- - - ">"
89
+ - - ">="
90
90
  - !ruby/object:Gem::Version
91
- version: 1.3.1
91
+ version: '0'
92
92
  requirements: []
93
93
  rubygems_version: 3.4.9
94
94
  signing_key: