bitvavo-api-upgraded 1.16.0__tar.gz → 1.17.0__tar.gz

{bitvavo_api_upgraded-1.16.0 → bitvavo_api_upgraded-1.17.0}/.gitignore

@@ -1,11 +1,12 @@
 /*
 
 # dirs
-!.github
-!requirements
-!scripts
-!src
-!tests
+!.github/
+!requirements/
+!scripts/
+!src/
+!tests/
+!docs/
 
 # files
 !.bumpversion.cfg

{bitvavo_api_upgraded-1.16.0 → bitvavo_api_upgraded-1.17.0}/CHANGELOG.md

@@ -1,9 +1,53 @@
 # Changelog
 
+## v1.17.0 - 2024-11-24
+
+Integrate all changes from Bitvavo's `v1.1.1` to `v1.4.2` lib versions,
+basically catching up their changes with our code. The reason for choosing
+`v1.1.1` as starting point, is because I'm not sure if I missed anything,
+because if I follow the timeline on PyPI is that I should pick `v1.2.2`, but if
+I look at my commit history, I should choose an older point. Oh well, it's only
+a little bit more work.
+
+I used [this Github
+link](https://github.com/bitvavo/python-bitvavo-api/compare/v1.1.1...v1.4.2) to
+compare their versions.
+
+### Added
+
+- `fees()` call. This was added to the Python SDK in early 2024.
+- `_default(value, fallback)` function, which ensures a `fallback` is returned,
+  if `value` is `None`. This ensures sane values will always be available.
+- `strintdict` type, as I had a bunch of `dict` types copied.
+
+### Changed
+
+- you can now do `from bitvavo_api_upgraded import Bitvavo`, instead of `from
+  bitvavo_api_upgraded.bitvavo import Bitvavo`, which always felt annoying. You
+  can still use the old way; no worries.
+- lowercased the http headers like `Bitvavo-Ratelimit-Remaining`, because
+  Bitvavo updated the API, which broke this code. This should probably fix the
+  issues of older versions of this lib going over the rate limit. 😅
+- `LICENSE.txt`'s year got updated
+- in `README.md`, below my text, I've replaced their old README with their
+  current one.
+- fixed coverage report; I switched to `pytest-cov`, from `coverage.py`
+  eventhough `pytest-cov` still uses `coverage.py`, but the output was messed up
+  (it also covered `tests/`, wich was unintentional)
+
+### Unchanged
+
+Normally I don't add this chapter, but I'm moving changes from Bitvavo's repo to
+here, so it's good I'll track this stuff for later.
+
+- I did NOT add the `name` var to `__init__.py`, because I'm pretty sure they
+  added it for their build process, but since I'm using `uv` I don't need that.
+- Did not add `self.timeout`, as I use `self.ACCESSWINDOW / 1000` instead.
+
 ## v1.16.0 - 2024-11-18
 
-Quite a few changes, most aimed at the maintenance of this project, but all changes are superficial - the functional
-code has not changed.
+Quite a few changes, most aimed at the maintenance of this project, but all
+changes are superficial - the functional code has not changed.
 
 ### Added
 

{bitvavo_api_upgraded-1.16.0 → bitvavo_api_upgraded-1.17.0}/LICENSE.txt

@@ -1,6 +1,6 @@
 ISC License
 
-Copyright (c) 2018, Bitvavo
+Copyright (c) 2024, 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
@@ -12,4 +12,4 @@ MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
 ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

bitvavo_api_upgraded-1.17.0/PKG-INFO

@@ -0,0 +1,319 @@
+Metadata-Version: 2.3
+Name: bitvavo-api-upgraded
+Version: 1.17.0
+Summary: A unit-tested fork of the Bitvavo API
+Project-URL: homepage, https://github.com/Thaumatorium/bitvavo-api-upgraded
+Project-URL: repository, https://github.com/Thaumatorium/bitvavo-api-upgraded
+Project-URL: changelog, https://github.com/Thaumatorium/bitvavo-api-upgraded/blob/master/CHANGELOG.md
+Author: Bitvavo BV (original code)
+Author-email: NostraDavid <55331731+NostraDavid@users.noreply.github.com>
+Maintainer-email: NostraDavid <55331731+NostraDavid@users.noreply.github.com>
+License: ISC License
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Framework :: Pytest
+Classifier: Framework :: tox
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: License :: OSI Approved :: ISC License (ISCL)
+Classifier: Operating System :: MacOS :: MacOS X
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: python-decouple==3.*,>=3.5
+Requires-Dist: requests==2.*,>=2.26
+Requires-Dist: structlog==24.*,>=21.5
+Requires-Dist: websocket-client==1.*,>=1.2
+Description-Content-Type: text/markdown
+
+# Bitvavo API (upgraded)
+
+## Userguide
+
+`pip install bitvavo_api_upgraded`
+
+Works the same as the official API lib, but I have:
+
+- typing for _all_ functions and classes
+- unit tests (I already found three bugs that I fixed, because the original code
+  wasn't tested, at all)
+- a changelog, so you can track of the changes that I make
+- compatible with Python 3.7 and newer ([3.6 isn't supported as of
+  2021-12-23](https://endoflife.date/python))
+
+## Devguide
+
+```shell
+echo "install development requirements"
+uv sync
+echo "run tox, a program that creates separate environments for different python versions, for testing purposes (among other things)"
+uv run tox
+```
+
+### Semantic Versioning (SemVer)
+
+I'm using semantic versioning, which means that changes mean this:
+
+1. MAJOR version when you make incompatible API changes,
+1. MINOR version when you add functionality in a backwards compatible manner,
+   and
+1. PATCH version when you make backwards compatible bug fixes.
+
+### Versioning
+
+Copy the following block to CHANGELOG.md and add all information since last
+version bump
+
+```markdown
+## $UNRELEASED
+
+### Added
+
+...
+
+### Changed
+
+...
+
+### Removed
+
+...
+```
+
+Commit those changes.
+
+After that, run `bump-my-version bump (major|minor|patch)` to automatically
+replace `$UNRELEASED` with the new version number, and also automatically tag
+and commit (with tag) to release a new version via the Github workflow.
+
+## py.typed
+
+Perhaps a curious file, but it simply exists to let `mypy` know that the code is
+typed: [Don't forget `py.typed` for your typed Python package
+](https://blog.whtsky.me/tech/2021/dont-forget-py.typed-for-your-typed-python-package/)
+
+## Last note
+
+_below this line is the old README.md_
+
+---
+
+# 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.
+
+To trade and execute your advanced trading strategies, Bitvavo SDK for Python is
+a wrapper that enables you to easily call every endpoint in [Bitvavo
+API](https://docs.bitvavo.com/).
+
+- [Prerequisites](#prerequisites) - what you need to start developing with
+  Bitvavo SDK for Python
+- [Get started](#get-started) - rapidly create an app and start trading with
+  Bitvavo
+- [About the SDK](#about-the-sdk) - general information about Bitvavo SDK for
+  Python
+- [API reference](https://docs.bitvavo.com/) - information on the specifics of
+  every parameter
+
+This page shows you how to use Bitvavo SDK for Python with WebSockets. For REST,
+see the [REST readme](docs/rest.md).
+
+## Prerequisites
+
+To start programming with Bitvavo SDK for Python you need:
+
+- [Python3](https://www.python.org/downloads/) installed on your development
+  environment
+
+  If you are working on macOS, ensure that you have installed SSH certificates:
+
+  ```terminal
+  open /Applications/Python\ 3.12/Install\ Certificates.command
+  open /Applications/Python\ 3.12/Update\ Shell\ Profile.command
+  ```
+
+- A Python app. Use your favorite IDE, or run from the command line
+- An [API key and
+  secret](https://support.bitvavo.com/hc/en-us/articles/4405059841809)
+  associated with your Bitvavo account
+
+  You control the actions your app can do using the rights you assign to the API
+  key. Possible rights are:
+
+  - **View**: retrieve information about your balance, account, deposit and
+    withdrawals
+  - **Trade**: place, update, view and cancel orders
+  - **Withdraw**: withdraw funds
+
+    Best practice is to not grant this privilege, withdrawals using the API do
+    not require 2FA and e-mail confirmation.
+
+## Get started
+
+Want to quickly make a trading app? Here you go:
+
+1. **Install Bitvavo SDK for Python**
+
+    In your Python app, add [Bitvavo SDK for
+    Python](https://github.com/bitvavo/python-bitvavo-api) from
+    [pypi.org](https://pypi.org/project/python-bitvavo-api/):
+
+    ```shell
+    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:
+
+    ```python
+    from python_bitvavo_api.bitvavo import Bitvavo
+    import json
+    import time
+
+    # Use this class to connect to Bitvavo and make your first calls.
+    # Add trading strategies to implement your business logic.
+    class BitvavoImplementation:
+        api_key = "<Replace with your your API key from Bitvavo Dashboard>"
+        api_secret = "<Replace with your API secret from Bitvavo Dashboard>"
+        bitvavo_engine = None
+        bitvavo_socket = None
+
+        # Connect securely to Bitvavo, create the WebSocket and error callbacks.
+        def __init__(self):
+            self.bitvavo_engine = Bitvavo({
+                'APIKEY': self.api_key,
+                'APISECRET': self.api_secret
+            })
+            self.bitvavo_socket = self.bitvavo_engine.newWebsocket()
+            self.bitvavo_socket.setErrorCallback(self.error_callback)
+
+        # Handle errors.
+        def error_callback(self, error):
+            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
+        # callbacks.
+        def a_trading_strategy(self):
+            self.bitvavo_socket.ticker24h({}, self.a_trading_strategy_callback)
+
+        # 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):
+            # Iterate through the markets
+            for market in response:
+
+                match market["market"]:
+                   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("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):
+            # The order return parameters explain the quote and the fees for this trade.
+            print("Order placed:", json.dumps(response, indent=2))
+            # Add your business logic.
+
+
+        # Sockets are fast, but asynchronous. Keep the socket open while you are
+        # trading.
+        def wait_and_close(self):
+            # Bitvavo uses a weight based rate limiting system. Your app is limited to 1000 weight points per IP or
+            # API key per minute. The rate weighting for each endpoint is supplied in Bitvavo API documentation.
+            # This call returns the amount of points left. If you make more requests than permitted by the weight limit,
+            # your IP or API key is banned.
+            limit = self.bitvavo_engine.getRemainingLimit()
+            try:
+                while (limit > 0):
+                    time.sleep(0.5)
+                    limit = self.bitvavo_engine.getRemainingLimit()
+            except KeyboardInterrupt:
+                self.bitvavo_socket.closeSocket()
+
+
+    # Shall I re-explain main? Naaaaaaaaaa.
+    if __name__ == '__main__':
+        bvavo = BitvavoImplementation()
+        bvavo.a_trading_strategy()
+        bvavo.wait_and_close()
+    ```
+
+1. **Add security information**
+
+   You must supply your security information to trade on Bitvavo and see your
+   account information using the authenticate methods. 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,
+   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**
+
+    - Command line warriors: `python3 <filename>`.
+    - IDE heroes: press the big green button.
+
+Your app connects to Bitvavo and returns a list the latest trade price for each
+market. You use this data to implement your trading logic.
+
+## About the SDK
+
+This section explains global concepts about Bitvavo SDK for Python.
+
+### Rate limit
+
+Bitvavo uses a weight based rate limiting system. Your app is limited to 1000
+weight points per IP or API key per minute. When you make a call to Bitvavo API,
+your remaining weight points are returned in the header of each REST request.
+
+Websocket methods do not return your returning weight points, you track your
+remaining weight points with a call to:
+
+```python
+limit = bitvavo.getRemainingLimit()
+```
+
+If you make more requests than permitted by the weight limit, your IP or API key
+is banned.
+
+The rate weighting for each endpoint is supplied in the [Bitvavo API
+documentation](https://docs.bitvavo.com/).
+
+### Requests
+
+For all methods, required parameters are passed as separate values, optional
+parameters are passed as a dictionary. Return parameters are in dictionary
+format: `response['<key>'] = '<value>'`. However, as a limit order requires more
+information than a market order, some optional parameters are required when you
+place an order.
+
+### Security
+
+You must set your API key and secret for authenticated endpoints, public
+endpoints do not require authentication.

bitvavo_api_upgraded-1.17.0/README.md

@@ -0,0 +1,284 @@
+# Bitvavo API (upgraded)
+
+## Userguide
+
+`pip install bitvavo_api_upgraded`
+
+Works the same as the official API lib, but I have:
+
+- typing for _all_ functions and classes
+- unit tests (I already found three bugs that I fixed, because the original code
+  wasn't tested, at all)
+- a changelog, so you can track of the changes that I make
+- compatible with Python 3.7 and newer ([3.6 isn't supported as of
+  2021-12-23](https://endoflife.date/python))
+
+## Devguide
+
+```shell
+echo "install development requirements"
+uv sync
+echo "run tox, a program that creates separate environments for different python versions, for testing purposes (among other things)"
+uv run tox
+```
+
+### Semantic Versioning (SemVer)
+
+I'm using semantic versioning, which means that changes mean this:
+
+1. MAJOR version when you make incompatible API changes,
+1. MINOR version when you add functionality in a backwards compatible manner,
+   and
+1. PATCH version when you make backwards compatible bug fixes.
+
+### Versioning
+
+Copy the following block to CHANGELOG.md and add all information since last
+version bump
+
+```markdown
+## $UNRELEASED
+
+### Added
+
+...
+
+### Changed
+
+...
+
+### Removed
+
+...
+```
+
+Commit those changes.
+
+After that, run `bump-my-version bump (major|minor|patch)` to automatically
+replace `$UNRELEASED` with the new version number, and also automatically tag
+and commit (with tag) to release a new version via the Github workflow.
+
+## py.typed
+
+Perhaps a curious file, but it simply exists to let `mypy` know that the code is
+typed: [Don't forget `py.typed` for your typed Python package
+](https://blog.whtsky.me/tech/2021/dont-forget-py.typed-for-your-typed-python-package/)
+
+## Last note
+
+_below this line is the old README.md_
+
+---
+
+# 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.
+
+To trade and execute your advanced trading strategies, Bitvavo SDK for Python is
+a wrapper that enables you to easily call every endpoint in [Bitvavo
+API](https://docs.bitvavo.com/).
+
+- [Prerequisites](#prerequisites) - what you need to start developing with
+  Bitvavo SDK for Python
+- [Get started](#get-started) - rapidly create an app and start trading with
+  Bitvavo
+- [About the SDK](#about-the-sdk) - general information about Bitvavo SDK for
+  Python
+- [API reference](https://docs.bitvavo.com/) - information on the specifics of
+  every parameter
+
+This page shows you how to use Bitvavo SDK for Python with WebSockets. For REST,
+see the [REST readme](docs/rest.md).
+
+## Prerequisites
+
+To start programming with Bitvavo SDK for Python you need:
+
+- [Python3](https://www.python.org/downloads/) installed on your development
+  environment
+
+  If you are working on macOS, ensure that you have installed SSH certificates:
+
+  ```terminal
+  open /Applications/Python\ 3.12/Install\ Certificates.command
+  open /Applications/Python\ 3.12/Update\ Shell\ Profile.command
+  ```
+
+- A Python app. Use your favorite IDE, or run from the command line
+- An [API key and
+  secret](https://support.bitvavo.com/hc/en-us/articles/4405059841809)
+  associated with your Bitvavo account
+
+  You control the actions your app can do using the rights you assign to the API
+  key. Possible rights are:
+
+  - **View**: retrieve information about your balance, account, deposit and
+    withdrawals
+  - **Trade**: place, update, view and cancel orders
+  - **Withdraw**: withdraw funds
+
+    Best practice is to not grant this privilege, withdrawals using the API do
+    not require 2FA and e-mail confirmation.
+
+## Get started
+
+Want to quickly make a trading app? Here you go:
+
+1. **Install Bitvavo SDK for Python**
+
+    In your Python app, add [Bitvavo SDK for
+    Python](https://github.com/bitvavo/python-bitvavo-api) from
+    [pypi.org](https://pypi.org/project/python-bitvavo-api/):
+
+    ```shell
+    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:
+
+    ```python
+    from python_bitvavo_api.bitvavo import Bitvavo
+    import json
+    import time
+
+    # Use this class to connect to Bitvavo and make your first calls.
+    # Add trading strategies to implement your business logic.
+    class BitvavoImplementation:
+        api_key = "<Replace with your your API key from Bitvavo Dashboard>"
+        api_secret = "<Replace with your API secret from Bitvavo Dashboard>"
+        bitvavo_engine = None
+        bitvavo_socket = None
+
+        # Connect securely to Bitvavo, create the WebSocket and error callbacks.
+        def __init__(self):
+            self.bitvavo_engine = Bitvavo({
+                'APIKEY': self.api_key,
+                'APISECRET': self.api_secret
+            })
+            self.bitvavo_socket = self.bitvavo_engine.newWebsocket()
+            self.bitvavo_socket.setErrorCallback(self.error_callback)
+
+        # Handle errors.
+        def error_callback(self, error):
+            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
+        # callbacks.
+        def a_trading_strategy(self):
+            self.bitvavo_socket.ticker24h({}, self.a_trading_strategy_callback)
+
+        # 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):
+            # Iterate through the markets
+            for market in response:
+
+                match market["market"]:
+                   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("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):
+            # The order return parameters explain the quote and the fees for this trade.
+            print("Order placed:", json.dumps(response, indent=2))
+            # Add your business logic.
+
+
+        # Sockets are fast, but asynchronous. Keep the socket open while you are
+        # trading.
+        def wait_and_close(self):
+            # Bitvavo uses a weight based rate limiting system. Your app is limited to 1000 weight points per IP or
+            # API key per minute. The rate weighting for each endpoint is supplied in Bitvavo API documentation.
+            # This call returns the amount of points left. If you make more requests than permitted by the weight limit,
+            # your IP or API key is banned.
+            limit = self.bitvavo_engine.getRemainingLimit()
+            try:
+                while (limit > 0):
+                    time.sleep(0.5)
+                    limit = self.bitvavo_engine.getRemainingLimit()
+            except KeyboardInterrupt:
+                self.bitvavo_socket.closeSocket()
+
+
+    # Shall I re-explain main? Naaaaaaaaaa.
+    if __name__ == '__main__':
+        bvavo = BitvavoImplementation()
+        bvavo.a_trading_strategy()
+        bvavo.wait_and_close()
+    ```
+
+1. **Add security information**
+
+   You must supply your security information to trade on Bitvavo and see your
+   account information using the authenticate methods. 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,
+   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**
+
+    - Command line warriors: `python3 <filename>`.
+    - IDE heroes: press the big green button.
+
+Your app connects to Bitvavo and returns a list the latest trade price for each
+market. You use this data to implement your trading logic.
+
+## About the SDK
+
+This section explains global concepts about Bitvavo SDK for Python.
+
+### Rate limit
+
+Bitvavo uses a weight based rate limiting system. Your app is limited to 1000
+weight points per IP or API key per minute. When you make a call to Bitvavo API,
+your remaining weight points are returned in the header of each REST request.
+
+Websocket methods do not return your returning weight points, you track your
+remaining weight points with a call to:
+
+```python
+limit = bitvavo.getRemainingLimit()
+```
+
+If you make more requests than permitted by the weight limit, your IP or API key
+is banned.
+
+The rate weighting for each endpoint is supplied in the [Bitvavo API
+documentation](https://docs.bitvavo.com/).
+
+### Requests
+
+For all methods, required parameters are passed as separate values, optional
+parameters are passed as a dictionary. Return parameters are in dictionary
+format: `response['<key>'] = '<value>'`. However, as a limit order requires more
+information than a market order, some optional parameters are required when you
+place an order.
+
+### Security
+
+You must set your API key and secret for authenticated endpoints, public
+endpoints do not require authentication.