XAPI: Add command line interface (CLI)

Author: pawelkn

README.md

@@ -24,40 +24,7 @@ pip install xapi-python
 
 To use xAPI, you will need to have an active account with the xStation5 trading platform. Once you have an account, you can use the xAPI library to connect to the platform and begin trading.
 
-Here is an example of how to use the xAPI library to connect to the xStation5 platform:
-
-```python
-import asyncio
-import xapi
-
-# Replace these values with your own credentials
-CREDENTIALS = {
-    "accountId": "<your_client_id>",
-    "password": "<your_password>",
-    "host": "ws.xtb.com",
-    "type": "real",
-    "safe": True
-}
-
-async def main():
-    try:
-        # Create a new xAPI object and connect to the xStation5 platform
-        async with await xapi.connect(**CREDENTIALS) as x:
-            pass
-
-    except xapi.LoginFailed as e:
-        print(f"Log in failed: {e}")
-
-    except xapi.ConnectionClosed as e:
-        print(f"Connection closed: {e}")
-
-if __name__ == "__main__":
-    asyncio.run(main())
-```
-
-Once you have connected to the platform, you can use the xAPI object to retrieve market data and execute trades.
-
-Here is an example of how to subscribe to market data using the xAPI library:
+Here is an example of how to use the xAPI library to connect to the xStation5 platform and subscribe to market data:
 
 ```python
 import asyncio
@@ -106,7 +73,6 @@ And here is an example of how to execute a trade using the xAPI library:
 ```python
 import asyncio
 import xapi
-from xapi import TradeCmd, TradeType, TradeStatus
 
 # Replace these values with your own credentials
 CREDENTIALS = {
@@ -144,6 +110,12 @@ if __name__ == "__main__":
     asyncio.run(main())
 ```
 
+## Command Line Interface (CLI)
+
+The xAPI library provides a command line interface (CLI) for interacting with the xStation5 API. You can run the xAPI commands without leaving the terminal. Just use the `xapi` command.
+
+![xAPI in action](assets/cli-example.gif)
+
 ## Examples
 
 To run the examples for the xAPI library, you will need to have an account with the xStation5 trading platform.

assets/cli-example.gif

@@ -1,8 +1,8 @@
 [project]
 name = "xapi-python"
-version = "0.1.7"
+version = "0.2.0"
 authors = [
-  { name="Paweł Knioła", email="pawel[email protected]" },
+  { name="Paweł Knioła", email="pawel@kniola.pl" },
 ]
 description = "The xStation5 API Python library"
 keywords = [
@@ -21,12 +21,17 @@ classifiers = [
   "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
-  "Programming Language :: Python :: 3.12"
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
 ]
 dependencies = [
-  "websockets>=11.0.2"
+  "websockets>=11.0.2",
+  "click>=8.1.8"
 ]
 
 [project.urls]
 "Homepage" = "https://github.com/pawelkn/xapi-python"
-"Bug Tracker" = "https://github.com/pawelkn/xapi-python/issues"
+"Bug Tracker" = "https://github.com/pawelkn/xapi-python/issues"
+
+[project.scripts]
+xapi = "xapi.cli:cli"

pyproject.toml

@@ -1 +1,2 @@
-websockets>=11.0.2
+websockets>=11.0.2
+click>=8.1.8

requirements.txt

@@ -3,7 +3,7 @@
 setup(
     name='xapi-python',
     author='Paweł Knioła',
-    author_email='pawel[email protected]',
+    author_email='pawel@kniola.pl',
     description='The xStation5 API Python library',
     long_description=open('README.md', encoding='utf-8').read(),
     license='MIT',
@@ -17,9 +17,10 @@
         "Programming Language :: Python :: 3.9",
         "Programming Language :: Python :: 3.10",
         "Programming Language :: Python :: 3.11",
-        "Programming Language :: Python :: 3.12"
+        "Programming Language :: Python :: 3.12",
+        "Programming Language :: Python :: 3.13",
     ],
     python_requires='>=3.7',
-    version="0.1.7",
+    version="0.2.0",
     packages=['xapi'],
 )

setup.py

@@ -1,9 +1,9 @@
 """
-.. moduleauthor:: Paweł Knioła <pawel[email protected]>
+.. moduleauthor:: Paweł Knioła <pawel@kniola.pl>
 """
 
 name = "xapi"
-__version__ = "0.1.7"
+__version__ = "0.2.0"
 
 from .xapi import XAPI, connect
 from .enums import TradeCmd, TradeType, TradeStatus, PeriodCode