Merge pull request #40 from bitvavo/FAVO-7518_Release-Python-SDK-v123_Iain

Favo 7518 release python sdk v123 iain

Author: IainTheTechWriter

.gitignore

@@ -1,4 +1,4 @@
 .DS_Store
-setup.py
 dist
-python_bitvavo_api.egg-info
+python_bitvavo_api.egg-info
+.idea

LICENSE.txt

@@ -1,6 +1,6 @@
 ISC License
 
-Copyright (c) 2018, Bitvavo
+Copyright (c) 2023, Bitvavo B.V.
 
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

README.md

@@ -1,10 +1,5 @@
 
-<table>
-  <tr>
-    <td><a href="https://bitvavo.com"><img alt="Bitvavo" src="docs/assets/bitvavo-mark-square-blue.svg" width="100" title="Bitvavo Logo"></a></td>
-    <td><h1>Bitvavo SDK for Python</h1></td>
-  </tr>
-</table>
+# Bitvavo SDK for Python
 
 Crypto starts with Bitvavo. 
 You use Bitvavo SDK for Python to buy, sell, and store over 200 digital assets on Bitvavo from inside your app. 
@@ -51,6 +46,10 @@ Want to quickly make a trading app? Here you go:
     ```terminal
     python -m pip install python_bitvavo_api
     ```
+
+    If you installed from `test.pypi.com`, update the requests library: `pip install --upgrade  requests`.   
+
+
 1. **Create a simple Bitvavo implementation**
 
     Add the following code to a new file in your app:
@@ -79,7 +78,8 @@ Want to quickly make a trading app? Here you go:
     
         # Handle errors.
         def error_callback(self, error):
-            print("Errors:", json.dumps(error, indent=2))
+            print("Add your error message.")
+            #print("Errors:", json.dumps(error, indent=2))
     
         # Retrieve the data you need from Bitvavo in order to implement your
         # trading logic. Use multiple workflows to return data to your
@@ -90,22 +90,24 @@ Want to quickly make a trading app? Here you go:
         # In your app you analyse data returned by the trading strategy, then make
         # calls to Bitvavo to respond to market conditions.
         def a_trading_strategy_callback(self, response):
-            print("All the latest trades:", json.dumps(response, indent=2))
-            # Iterate through the
+            # Iterate through the markets
             for market in response:
-                print("Iterate through markets:", market["market"] )
+    
                 match market["market"]:
-                   case "ABC-EUR":
-                        print("Check data against your trading strategy. For example, the bid is: ", market["bid"] )
+                   case "ZRX-EUR":
+                        print("Eureka, the latest bid for ZRX-EUR is: ", market["bid"] )
                         # Implement calculations for your trading logic.
                         # If they are positive, place an order: For example:
-                        # self.bitvavo_socket.placeOrder("ABC-EUR",
+                        # self.bitvavo_socket.placeOrder("ZRX-EUR",
                         #                               'buy',
                         #                               'limit',
                         #                               { 'amount': '1', 'price': '00001' },
                         #                               self.order_placed_callback)
                    case "a different market":
                         print("do something else")
+                   case _:
+                        print("Not this one: ", market["market"])
+    
     
     
         def order_placed_callback(self, response):
@@ -128,8 +130,8 @@ Want to quickly make a trading app? Here you go:
                     limit = self.bitvavo_engine.getRemainingLimit()
             except KeyboardInterrupt:
                 self.bitvavo_socket.closeSocket()
-    
-    
+
+
     # Shall I re-explain main? Naaaaaaaaaa.
     if __name__ == '__main__':
         bvavo = BitvavoImplementation()
@@ -143,7 +145,8 @@ Want to quickly make a trading app? Here you go:
     Replace the values of  `api_key` and `api_secret` with your credentials from [Bitvavo Dashboard](https://account.bitvavo.com/user/api). 
 
     You can retrieve public information such as available markets, assets and current market without supplying your key and secret. 
-    However, Bitvavo returns an error.
+    However, unauthenticated calls have lower rate limits based on your IP address, and your account is blocked for longer if 
+    you exceed your limit.
 
 1. **Run your app**
 

python_bitvavo_api/__init__.py

@@ -0,0 +1 @@
+name = "pythonBitvavoApi"

setup.py

@@ -0,0 +1,29 @@
+from setuptools import setup, find_packages
+from os import path
+
+# read the contents of your README file
+this_directory = path.abspath(path.dirname(__file__))
+with open(path.join(this_directory, 'README.md'), encoding='utf-8') as f:
+    long_description = f.read()
+
+setup(
+    name="python_bitvavo_api",
+    long_description=long_description,
+    long_description_content_type='text/markdown',
+    version="1.2.3",
+    author="Bitvavo",
+    description="Use Bitvavo SDK for Python to buy, sell, and store over 200 digital assets on Bitvavo from inside your app.",
+    url="https://github.com/bitvavo/python-bitvavo-api",
+    packages=find_packages(),
+    install_requires=[
+        'websocket-client',
+        'requests==2.31.0',
+        'setuptools'
+    ],
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "License :: OSI Approved :: ISC License (ISCL)",
+        "Operating System :: OS Independent",
+    ],
+    python_requires=">=3.6",
+)