onetick-ext-view 1.4.0__tar.gz

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 (15) hide show
  1. onetick_ext_view-1.4.0/LICENSE +21 -0
  2. onetick_ext_view-1.4.0/PKG-INFO +88 -0
  3. onetick_ext_view-1.4.0/README.md +73 -0
  4. onetick_ext_view-1.4.0/README_short.md +59 -0
  5. onetick_ext_view-1.4.0/onetick_ext_view/__init__.py +1 -0
  6. onetick_ext_view-1.4.0/onetick_ext_view/app.py +1370 -0
  7. onetick_ext_view-1.4.0/onetick_ext_view/plugin.py +1 -0
  8. onetick_ext_view-1.4.0/onetick_ext_view.egg-info/PKG-INFO +88 -0
  9. onetick_ext_view-1.4.0/onetick_ext_view.egg-info/SOURCES.txt +13 -0
  10. onetick_ext_view-1.4.0/onetick_ext_view.egg-info/dependency_links.txt +1 -0
  11. onetick_ext_view-1.4.0/onetick_ext_view.egg-info/entry_points.txt +2 -0
  12. onetick_ext_view-1.4.0/onetick_ext_view.egg-info/requires.txt +10 -0
  13. onetick_ext_view-1.4.0/onetick_ext_view.egg-info/top_level.txt +1 -0
  14. onetick_ext_view-1.4.0/pyproject.toml +66 -0
  15. onetick_ext_view-1.4.0/setup.cfg +4 -0
onetick_ext_view-1.4.0/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 OneMarketData, LLC
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
onetick_ext_view-1.4.0/PKG-INFO ADDED
@@ -0,0 +1,88 @@
1
+ Metadata-Version: 2.4
2
+ Name: onetick-ext-view
3
+ Version: 1.4.0
4
+ Summary: OneTick database viewer
5
+ Author-email: solutions <solutions@onetick.com>
6
+ License-Expression: MIT
7
+ Project-URL: OneTick, https://onetick.com
8
+ Project-URL: onetick-py, https://pypi.org/project/onetick-py/
9
+ Classifier: Topic :: Database :: Front-Ends
10
+ Classifier: Topic :: Scientific/Engineering
11
+ Classifier: Programming Language :: Python :: 3.9
12
+ Classifier: Programming Language :: Python :: 3.10
13
+ Classifier: Programming Language :: Python :: 3.11
14
+ Classifier: Programming Language :: Python :: 3.12
15
+ Classifier: Programming Language :: Python :: 3.13
16
+ Classifier: Operating System :: OS Independent
17
+ Classifier: Environment :: Console
18
+ Requires-Python: >=3.9
19
+ Description-Content-Type: text/markdown
20
+ License-File: LICENSE
21
+ Requires-Dist: onetick-py>=1.188.0
22
+ Requires-Dist: npyscreen>=4.10.5
23
+ Requires-Dist: windows-curses==2.4.1; platform_system == "Windows"
24
+ Requires-Dist: pandas
25
+ Requires-Dist: pytz
26
+ Provides-Extra: webapi
27
+ Requires-Dist: onetick-py[webapi]>=1.188.0; extra == "webapi"
28
+ Dynamic: license-file
29
+
30
+ ## onetick-ext-view
31
+
32
+ Onetick View is a terminal UI for browsing Onetick databases.
33
+
34
+ It is based on [onetick-py](https://pypi.org/project/onetick-py/) library and can work in two modes: localy-installed mode and WebAPI mode.
35
+ The mode depends on the set environment variables and installed onetick python api libraries.
36
+ See onetick-py documentation for details: https://docs.pip.distribution.sol.onetick.com/static/installation/webapi.html.
37
+
38
+ In order to use WebAPI mode install package with `webapi` extra:
39
+ ```
40
+ pip install onetick-ext-view[webapi]
41
+ ```
42
+
43
+ #### Usage (WebAPI mode):
44
+
45
+ # set env variables:
46
+ OTP_HTTP_ADDRESS='https://rest.cloud.onetick.com'
47
+ OTP_ACCESS_TOKEN_URL='https://cloud-auth.parent.onetick.com/realms/OMD/protocol/openid-connect/token'
48
+ OTP_CLIENT_ID='?????????????'
49
+ OTP_CLIENT_SECRET='?????????'
50
+
51
+ onetick view # (get remote databases from WebAPI server)
52
+
53
+ #### Usage (locally-installed mode):
54
+
55
+ # set env variables:
56
+ MAIN_ONE_TICK_DIR="/opt/one_market_data/one_tick"
57
+
58
+ onetick view # (scan current working dir)
59
+ onetick view /tmp # (i.e. for tests with --keep-generated=always)
60
+ onetick view --remote-ts remote.example.com:40001 # (connect to remote server)
61
+ onetick view /tmp --remote-ts remote.example.com:40001 # (both scan specific directory and connect to remote server)
62
+
63
+ #### Program windows:
64
+ 1. Databases window: does recursive search in subdirectories
65
+ and shows available databases
66
+ - press Q to quit
67
+
68
+ 2. Dates window: shows available dates for selected database
69
+ - press C to show record count (may be slow - scans all DBs)
70
+ - press Esc or Backspace to go back
71
+ - press Q to quit
72
+
73
+ 3. Tick types window: shows available tick types for a specific day
74
+ - press + or - to change scroll speed (1, 10, 100 lines)
75
+ - press Esc or Backspace to go back
76
+
77
+ 4. Symbols window: shows available symbols & tick types
78
+ - press C to show record count
79
+ - press + or - to change scroll speed (1, 10, 100 lines)
80
+ - press Esc or Backspace to go back
81
+
82
+ 5. Data window: shows symbol data
83
+ - Use arrows to navigate dataframe
84
+ - press Space to zoom in top left data cell (i.e. view long alert description string)
85
+ - press T to transpose table
86
+ - press + or - to change scroll speed (1, 10, 100 lines)
87
+ - press C to dump dataframe to CSV file
88
+ - press Esc or Backspace to go back
onetick_ext_view-1.4.0/README.md ADDED
@@ -0,0 +1,73 @@
1
+ ## onetick-ext-view
2
+
3
+ Onetick View is a terminal UI for browsing Onetick databases.
4
+
5
+ It is based on [onetick-py](https://pypi.org/project/onetick-py/) library and can work in two modes: localy-installed mode and WebAPI mode.
6
+ The mode depends on the set environment variables and installed onetick python api libraries.
7
+ See onetick-py documentation for details: https://docs.pip.distribution.sol.onetick.com/static/installation/webapi.html.
8
+
9
+ In order to use WebAPI mode install package with `webapi` extra:
10
+ ```
11
+ pip install onetick-ext-view[webapi]
12
+ ```
13
+
14
+ #### Usage (WebAPI mode):
15
+
16
+ # set env variables:
17
+ OTP_HTTP_ADDRESS='https://rest.cloud.onetick.com'
18
+ OTP_ACCESS_TOKEN_URL='https://cloud-auth.parent.onetick.com/realms/OMD/protocol/openid-connect/token'
19
+ OTP_CLIENT_ID='?????????????'
20
+ OTP_CLIENT_SECRET='?????????'
21
+
22
+ onetick view # (get remote databases from WebAPI server)
23
+
24
+ #### Usage (locally-installed mode):
25
+
26
+ # set env variables:
27
+ MAIN_ONE_TICK_DIR="/opt/one_market_data/one_tick"
28
+
29
+ onetick view # (scan current working dir)
30
+ onetick view /tmp # (i.e. for tests with --keep-generated=always)
31
+ onetick view --remote-ts remote.example.com:40001 # (connect to remote server)
32
+ onetick view /tmp --remote-ts remote.example.com:40001 # (both scan specific directory and connect to remote server)
33
+
34
+ #### Program windows:
35
+ 1. Databases window: does recursive search in subdirectories
36
+ and shows available databases
37
+ - press Q to quit
38
+
39
+
40
+ ![Databases window](static/window_db.png "Databases window")
41
+
42
+
43
+ 2. Dates window: shows available dates for selected database
44
+ - press C to show record count (may be slow - scans all DBs)
45
+ - press Esc or Backspace to go back
46
+ - press Q to quit
47
+
48
+
49
+ ![Dates window](static/window_dates.png "Dates window")
50
+
51
+ 3. Tick types window: shows available tick types for a specific day
52
+ - press + or - to change scroll speed (1, 10, 100 lines)
53
+ - press Esc or Backspace to go back
54
+
55
+ 4. Symbols window: shows available symbols & tick types
56
+ - press C to show record count
57
+ - press + or - to change scroll speed (1, 10, 100 lines)
58
+ - press Esc or Backspace to go back
59
+
60
+
61
+ ![Symbols window](static/window_symbols.png "Symbols window")
62
+
63
+
64
+ 5. Data window: shows symbol data
65
+ - Use arrows to navigate dataframe
66
+ - press Space to zoom in top left data cell (i.e. view long alert description string)
67
+ - press T to transpose table
68
+ - press + or - to change scroll speed (1, 10, 100 lines)
69
+ - press C to dump dataframe to CSV file
70
+ - press Esc or Backspace to go back
71
+
72
+
73
+ ![Data window](static/window_data.png "Data window")
onetick_ext_view-1.4.0/README_short.md ADDED
@@ -0,0 +1,59 @@
1
+ ## onetick-ext-view
2
+
3
+ Onetick View is a terminal UI for browsing Onetick databases.
4
+
5
+ It is based on [onetick-py](https://pypi.org/project/onetick-py/) library and can work in two modes: localy-installed mode and WebAPI mode.
6
+ The mode depends on the set environment variables and installed onetick python api libraries.
7
+ See onetick-py documentation for details: https://docs.pip.distribution.sol.onetick.com/static/installation/webapi.html.
8
+
9
+ In order to use WebAPI mode install package with `webapi` extra:
10
+ ```
11
+ pip install onetick-ext-view[webapi]
12
+ ```
13
+
14
+ #### Usage (WebAPI mode):
15
+
16
+ # set env variables:
17
+ OTP_HTTP_ADDRESS='https://rest.cloud.onetick.com'
18
+ OTP_ACCESS_TOKEN_URL='https://cloud-auth.parent.onetick.com/realms/OMD/protocol/openid-connect/token'
19
+ OTP_CLIENT_ID='?????????????'
20
+ OTP_CLIENT_SECRET='?????????'
21
+
22
+ onetick view # (get remote databases from WebAPI server)
23
+
24
+ #### Usage (locally-installed mode):
25
+
26
+ # set env variables:
27
+ MAIN_ONE_TICK_DIR="/opt/one_market_data/one_tick"
28
+
29
+ onetick view # (scan current working dir)
30
+ onetick view /tmp # (i.e. for tests with --keep-generated=always)
31
+ onetick view --remote-ts remote.example.com:40001 # (connect to remote server)
32
+ onetick view /tmp --remote-ts remote.example.com:40001 # (both scan specific directory and connect to remote server)
33
+
34
+ #### Program windows:
35
+ 1. Databases window: does recursive search in subdirectories
36
+ and shows available databases
37
+ - press Q to quit
38
+
39
+ 2. Dates window: shows available dates for selected database
40
+ - press C to show record count (may be slow - scans all DBs)
41
+ - press Esc or Backspace to go back
42
+ - press Q to quit
43
+
44
+ 3. Tick types window: shows available tick types for a specific day
45
+ - press + or - to change scroll speed (1, 10, 100 lines)
46
+ - press Esc or Backspace to go back
47
+
48
+ 4. Symbols window: shows available symbols & tick types
49
+ - press C to show record count
50
+ - press + or - to change scroll speed (1, 10, 100 lines)
51
+ - press Esc or Backspace to go back
52
+
53
+ 5. Data window: shows symbol data
54
+ - Use arrows to navigate dataframe
55
+ - press Space to zoom in top left data cell (i.e. view long alert description string)
56
+ - press T to transpose table
57
+ - press + or - to change scroll speed (1, 10, 100 lines)
58
+ - press C to dump dataframe to CSV file
59
+ - press Esc or Backspace to go back
onetick_ext_view-1.4.0/onetick_ext_view/__init__.py ADDED
@@ -0,0 +1 @@
1
+ __version__ = '1.4.0'