├── .gitignore ├── LICENSE ├── README.md ├── screen_python_large.png ├── screen_python_small.png └── src ├── stock_list_demo.py └── subscription_listener.py /.gitignore: -------------------------------------------------------------------------------- 1 | __pycache__ 2 | .python-version -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Lightstreamer - Basic Stock-List Demo - Python Client 2 | 3 | This project contains an example of a Python application that employs the **Lightstreamer Python Client library**. 4 | 5 | ![screenshot](screen_python_large.png) 6 | 7 | ## Details 8 | 9 | The example provides a very simple version of the [Stock-List Demos](https://github.com/Lightstreamer/Lightstreamer-example-Stocklist-client-javascript), where a single subscription to 12 items is submitted. 10 | The updates are then formatted and displayed on the console. 11 | 12 | The script shows all the basic steps required to establish an interaction to Lightstreamer Server. More specifically, the code comprises these actions: 13 | 14 | * Connection to Lightstreamer server and session creation 15 | * Subscription to items with specified fields 16 | * Notification about real time updates 17 | * Unsubscription from items 18 | * Final disconnection 19 | 20 | ## Install 21 | 22 | If you want to install a version of this demo pointing to your local Lightstreamer Server, follow these steps: 23 | 24 | * Note that, as prerequisite, the [Lightstreamer - Stock- List Demo - Java Adapter](https://github.com/Lightstreamer/Lightstreamer-example-Stocklist-adapter-java) has to be deployed on your local Lightstreamer Server instance. Please check out that project and follow the installation instructions provided with it. 25 | * Launch Lightstreamer Server. 26 | * Go to [http://python.org/download/](http://python.org/download/) and download the appropriate **Python** (tested since version 3.9) for your OS and follow the instructions to install it on your system. Note that the demo currently **can not** be launched from IDLE. 27 | * Install the latest version of the _Lightstreamer Python Client library_ from [PyPi](https://pypi.org/project/lightstreamer-client-lib/): `python -m pip install lightstreamer-client-lib` 28 | 29 | You can now run the Python script simply executing the following commands on different OS: 30 | 31 | * Windows machines: 32 | 33 | ``` 34 | start python /path/to/example/stock_list_demo.py 35 | ``` 36 | 37 | * Linux machines: 38 | 39 | ``` 40 | python /path/to/example/stock_list_demo.py 41 | ``` 42 | or, alternatively, you can make the script executable: 43 | 44 | ``` 45 | chmod +x /path/to/example/stock_list_demo.py 46 | ``` 47 | 48 | and then type: 49 | ``` 50 | /path/to/example/stock_list_demo.py 51 | ``` 52 | 53 | The example is configured to connect to http://push.lightstreamer.com:80, but you can easily change these settings modifying the following line: 54 | 55 | ```lightstreamer_client = LightstreamerClient("http://push.lightstreamer.com:80", "DEMO")``` 56 | 57 | to connect to the correct combination of host and port of your Lightstreamer server. 58 | 59 | ### Lightstreamer Adapters Needed by this Demo Client 60 | 61 | 62 | * [Lightstreamer - Stock- List Demo - Java Adapter](https://github.com/Lightstreamer/Lightstreamer-example-Stocklist-adapter-java) 63 | 64 | 65 | 66 | ### Related Projects 67 | 68 | * [Demos](https://demos.lightstreamer.com) 69 | * [Lightstreamer - Stock-List Demos - HTML Clients](https://github.com/Lightstreamer/Lightstreamer-example-Stocklist-client-javascript) 70 | * [Lightstreamer - Basic Stock-List Demo - jQuery (jqGrid) Client](https://github.com/Lightstreamer/Lightstreamer-example-StockList-client-jquery) 71 | * [Lightstreamer - Stock-List Demo - Dojo Toolkit Client](https://github.com/Lightstreamer/Lightstreamer-example-StockList-client-dojo) 72 | * [Lightstreamer - Basic Stock-List Demo - Java SE (Swing) Client](https://github.com/Lightstreamer/Lightstreamer-example-StockList-client-java) 73 | * [Lightstreamer - Basic Stock-List Demo - .NET Client](https://github.com/Lightstreamer/Lightstreamer-example-StockList-client-dotnet) 74 | 75 | ## Lightstreamer Compatibility Notes 76 | 77 | * Compatible with Lightstreamer Python Client SDK 1.0 or newer. 78 | * Compatible with Lightstreamer Server since version 7.3.2. -------------------------------------------------------------------------------- /screen_python_large.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Lightstreamer/Lightstreamer-example-StockList-client-python/7db52e35ae096469c463372625ca48f91234f4ea/screen_python_large.png -------------------------------------------------------------------------------- /screen_python_small.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Lightstreamer/Lightstreamer-example-StockList-client-python/7db52e35ae096469c463372625ca48f91234f4ea/screen_python_small.png -------------------------------------------------------------------------------- /src/stock_list_demo.py: -------------------------------------------------------------------------------- 1 | #!/usr/bin/python 2 | 3 | # Copyright (c) Lightstreamer Srl. 4 | # 5 | # Licensed under the Apache License, Version 2.0 (the "License"); 6 | # you may not use this file except in compliance with the License. 7 | # You may obtain a copy of the License at 8 | # 9 | # http://www.apache.org/licenses/LICENSE-2.0 10 | # 11 | # Unless required by applicable law or agreed to in writing, software 12 | # distributed under the License is distributed on an "AS IS" BASIS, 13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 14 | # See the License for the specific language governing permissions and 15 | # limitations under the License. 16 | 17 | from lightstreamer.client import * 18 | from subscription_listener import * 19 | 20 | def wait_for_input(): 21 | input("{0:-^80}\n".format("HIT CR TO UNSUBSCRIBE AND DISCONNECT FROM LIGHTSTREAMER")) 22 | 23 | loggerProvider = ConsoleLoggerProvider(ConsoleLogLevel.WARN) 24 | LightstreamerClient.setLoggerProvider(loggerProvider) 25 | 26 | # Establishing a new connection to Lightstreamer Server 27 | # lightstreamer_client = LightstreamerClient("http://localhost:8080", "DEMO") 28 | lightstreamer_client = LightstreamerClient("http://push.lightstreamer.com", "DEMO") 29 | lightstreamer_client.connect() 30 | 31 | # Making a new Subscription in MERGE mode 32 | subscription = Subscription( 33 | mode="MERGE", 34 | items=["item1", "item2", "item3", "item4", 35 | "item5", "item6", "item7", "item8", 36 | "item9", "item10", "item11", "item12"], 37 | fields=["stock_name", "last_price", "time", "bid", "ask"]) 38 | subscription.setDataAdapter("QUOTE_ADAPTER") 39 | 40 | # Adding the subscription listener to get notifications about new updates 41 | subscription.addListener(SubListener()) 42 | 43 | # Registering the Subscription 44 | lightstreamer_client.subscribe(subscription) 45 | 46 | wait_for_input() 47 | 48 | # Unsubscribing from Lightstreamer by using the subscription as key 49 | lightstreamer_client.unsubscribe(subscription) 50 | 51 | # Disconnecting 52 | lightstreamer_client.disconnect() 53 | -------------------------------------------------------------------------------- /src/subscription_listener.py: -------------------------------------------------------------------------------- 1 | # A class implementing the SubscriptionListener interface 2 | class SubListener: 3 | def onItemUpdate(self, update): 4 | print("{stock_name:<19}: Last{last_price:>6} - Time {time:<8} - " 5 | "Bid {bid:>5} - Ask {ask:>5}".format( 6 | stock_name=update.getValue("stock_name"), 7 | last_price=update.getValue("last_price"), 8 | time=update.getValue("time"), 9 | bid=update.getValue("bid"), 10 | ask=update.getValue("ask"))) 11 | pass 12 | def onClearSnapshot(self, itemName, itemPos): 13 | pass 14 | def onCommandSecondLevelItemLostUpdates(self, lostUpdates, key): 15 | pass 16 | def onCommandSecondLevelSubscriptionError(self, code, message, key): 17 | pass 18 | def onEndOfSnapshot(self, itemName, itemPos): 19 | pass 20 | def onItemLostUpdates(self, itemName, itemPos, lostUpdates): 21 | pass 22 | def onListenEnd(self): 23 | pass 24 | def onListenStart(self): 25 | pass 26 | def onSubscription(self): 27 | pass 28 | def onSubscriptionError(self, code, message): 29 | pass 30 | def onUnsubscription(self): 31 | pass 32 | def onRealMaxFrequency(self, frequency): 33 | pass --------------------------------------------------------------------------------