0.14.2 RC1

Author: oliver-zehentleitner

.github/workflows/build_wheels.yml

@@ -10,7 +10,7 @@ jobs:
     name: Build wheels on ${{ matrix.os }}
     runs-on: ${{ matrix.os }}
     env:
-      CIBW_PYPY_VERSION: "7.3.10*"
+      CIBW_SKIP: "pp36-* pp37-* pp38-*"
     strategy:
       matrix:
         os: [ubuntu-20.04, windows-2019, macos-11]

.github/workflows/unit-tests.yml

@@ -35,6 +35,7 @@ jobs:
     - name: Upload coverage to Codecov
       uses: codecov/codecov-action@v3
       with:
+        token: ${{ secrets.CODECOV_TOKEN }}
         flags: unittests
         name: codecov-umbrella
         verbose: true

.gitignore

@@ -15,6 +15,7 @@ __pycache__/
 # Distribution / packaging
 .Python
 build/
+stubs/
 develop-eggs/
 dist/
 downloads/

CHANGELOG.md

@@ -9,7 +9,15 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 [How to upgrade to the latest version!](https://unicorn-fy.docs.lucit.tech/readme.html#installation-and-upgrade)
 
-## 0.14.1.dev (development stage/unreleased/unstable)
+## 0.14.2.dev (development stage/unreleased/unstable)
+
+## 0.14.2
+### Added
+- Since Unicorn-Fy is delivered as a compiled C extension, IDEs such as Pycharm and Visual Code cannot use information 
+  about available methods, parameters and their types for autocomplete and other intellisense functions. As a solution, 
+  from now on stub files (PYI) will be created in the build process and attached to the packages. The IDEs can 
+  automatically obtain the required information from these.
+
 ## 0.14.1
 `unicorn-fy` can now also be installed on all architectures on which there are no precompiled packages from LUCIT. PIP 
 now automatically recognises whether there is a suitable precompiled package and if not, the source is automatically 

README.md

@@ -29,7 +29,7 @@
 [Examples](#examples) | [Wiki](#wiki) | [Social](#social) | [Notifications](#receive-notifications) | [Bugs](#how-to-report-bugs-or-suggest-improvements) 
 | [Contributing](#contributing) | [Disclaimer](#disclaimer) | [Commercial Support](#commercial-support)
 
-A Python API by [LUCIT](https://www.lucit.tech) to convert received raw data from crypto exchange API endpoints 
+A Python SDK by [LUCIT](https://www.lucit.tech) to convert received raw data from crypto exchange API endpoints 
 into well-formed python dictionaries.
 
 Part of ['UNICORN Binance Suite'](https://www.lucit.tech/unicorn-binance-suite.html).
@@ -66,7 +66,7 @@ Output:
 {'stream_type': 'btcusdt@trade', 'event_type': 'trade', 'event_time': 1556876873656, 'symbol': 'BTCUSDT',
  'trade_id': 117727701, 'price': '5786.76000000', 'quantity': '0.03200500', 'buyer_order_id': 341831847,
  'seller_order_id': 341831876, 'trade_time': 1556876873648, 'is_market_maker': True, 'ignore': True,
- 'unicorn_fied': ['binance', '1.14.1']}
+ 'unicorn_fied': ['binance', '0.14.2']}
 ```
 
 This lib is integrated into 
@@ -113,13 +113,26 @@ If you like the project, please
 ## Installation and Upgrade
 The module requires Python 3.7.0 or above. 
 
+For Anaconda we offer packages only from Python version 3.8 and higher.
+
 For the PyPy interpreter we offer packages only from Python version 3.9 and higher.
 
 The current dependencies are listed 
 [here](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/blob/master/requirements.txt).
 
 If you run into errors during the installation take a look [here](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/wiki/Installation).
 
+### Packages are created automatically with GitHub Actions
+When a new release is to be created, we start two GitHubActions: 
+
+- [Build and Publish Anaconda](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/actions/workflows/build_conda.yml)
+- [Build and Publish GH+PyPi](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/actions/workflows/build_wheels.yml) 
+
+Both start virtual Windows/Linux/Mac servers provided by GitHub in the cloud with preconfigured environments and 
+create the respective compilations and stub files, pack them into wheels and conda packages and then publish them on 
+GitHub, PYPI and Anaconda. This is a transparent method that makes it possible to trace the source code behind a 
+compilation.
+
 ### A Cython binary, PyPy or source code based CPython wheel of the latest version with `pip` from [PyPI](https://pypi.org/project/unicorn-binance-rest-api/)
 Our [Cython](https://cython.org/) and [PyPy](https://www.pypy.org/) Wheels are available on [PyPI](https://pypi.org/), 
 these wheels offer significant advantages for Python developers:
@@ -173,9 +186,9 @@ Run in bash:
 `pip install https://github.com/LUCIT-Systems-and-Development/unicorn-fy/archive/$(curl -s https://api.github.com/repos/lucit-systems-and-development/unicorn-fy/releases/latest | grep -oP '"tag_name": "\K(.*)(?=")').tar.gz --upgrade`
 
 #### Windows
-Use the below command with the version (such as 1.14.1) you determined [here](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/releases/latest):
+Use the below command with the version (such as 0.14.2) you determined [here](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/releases/latest):
 
-`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-fy/archive/1.14.1.tar.gz --upgrade`
+`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-fy/archive/0.14.2.tar.gz --upgrade`
 
 ### From the latest source (dev-stage) with PIP from [GitHub](https://github.com/LUCIT-Systems-and-Development/unicorn-fy)
 This is not a release version and can not be considered to be stable!
@@ -194,16 +207,14 @@ or the [current master branch](https://github.com/LUCIT-Systems-and-Development/
 - ./setup.py
 
 ## Change Log
-[https://unicorn-fy.docs.lucit.tech//CHANGELOG.html](https://unicorn-fy.docs.lucit.tech//CHANGELOG.html)
+[https://unicorn-fy.docs.lucit.tech/changelog.html](https://unicorn-fy.docs.lucit.tech/changelog.html)
 
 ## Documentation
 - [General](https://unicorn-fy.docs.lucit.tech/)
 - [Modules](https://unicorn-fy.docs.lucit.tech/modules.html)
 
 ## Examples
-- [example_logging.py](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/blob/master/example_logging.py)
-- [example_unicorn_fy.py](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/blob/master/example_unicorn_fy.py)
-- [example_version_of_this_package.py](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/blob/master/example_version_of_this_package.py)
+- [Look here!](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/tree/master/examples/)
 
 ## Project Homepage
 [https://www.lucit.tech/unicorn-fy.html](https://www.lucit.tech/unicorn-fy.html)

dev/reset.sh

@@ -6,8 +6,11 @@ rm dev/*.log
 rm build -r
 rm dist -r
 rm *.egg-info -r
+rm stubs -r
+rm out -r
 
 rm unicorn_fy/*.c
 rm unicorn_fy/*.html
 rm unicorn_fy/*.dll
 rm unicorn_fy/*.so
+rm unicorn_fy/*.pyi

dev/set_version_config.txt

@@ -1,2 +1,2 @@
-1.14.1
+0.14.2
 meta.yaml,pyproject.toml,setup.py,README.md,.github/workflows/build_wheels.yml,dev/sphinx/source/conf.py,unicorn_fy/unicorn_fy.py

dev/sphinx/source/changelog.md

@@ -9,9 +9,17 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/) and this p
 
 [How to upgrade to the latest version!](https://unicorn-fy.docs.lucit.tech/readme.html#installation-and-upgrade)
 
-## 0.14.1.dev (development stage/unreleased/unstable)
+## 0.14.2.dev (development stage/unreleased/unstable)
+
+## 0.14.2
+### Added
+- Since Unicorn-Fy is delivered as a compiled C extension, IDEs such as Pycharm and Visual Code cannot use information 
+  about available methods, parameters and their types for autocomplete and other intellisense functions. As a solution, 
+  from now on stub files (PYI) will be created in the build process and attached to the packages. The IDEs can 
+  automatically obtain the required information from these.
+
 ## 0.14.1
-UnicornFy can now also be installed on all architectures on which there are no precompiled packages from LUCIT. PIP 
+`unicorn-fy` can now also be installed on all architectures on which there are no precompiled packages from LUCIT. PIP 
 now automatically recognises whether there is a suitable precompiled package and if not, the source is automatically 
 compiled on the target system during the installation process with Cython. Even if you don't have to do anything 
 special, please note that this process takes some time!

dev/sphinx/source/conf.py

@@ -22,7 +22,7 @@
 author = 'LUCIT Systems and Development'
 
 # The full version, including alpha/beta/rc tags
-release = '1.14.1'
+release = '0.14.2'
 
 html_last_updated_fmt = "%b %d %Y at %H:%M (CET)"
 

dev/sphinx/source/readme.md

@@ -29,7 +29,7 @@
 [Examples](#examples) | [Wiki](#wiki) | [Social](#social) | [Notifications](#receive-notifications) | [Bugs](#how-to-report-bugs-or-suggest-improvements) 
 | [Contributing](#contributing) | [Disclaimer](#disclaimer) | [Commercial Support](#commercial-support)
 
-A Python API by [LUCIT](https://www.lucit.tech) to convert received raw data from crypto exchange API endpoints 
+A Python SDK by [LUCIT](https://www.lucit.tech) to convert received raw data from crypto exchange API endpoints 
 into well-formed python dictionaries.
 
 Part of ['UNICORN Binance Suite'](https://www.lucit.tech/unicorn-binance-suite.html).
@@ -66,7 +66,7 @@ Output:
 {'stream_type': 'btcusdt@trade', 'event_type': 'trade', 'event_time': 1556876873656, 'symbol': 'BTCUSDT',
  'trade_id': 117727701, 'price': '5786.76000000', 'quantity': '0.03200500', 'buyer_order_id': 341831847,
  'seller_order_id': 341831876, 'trade_time': 1556876873648, 'is_market_maker': True, 'ignore': True,
- 'unicorn_fied': ['binance', '1.14.1']}
+ 'unicorn_fied': ['binance', '0.14.2']}
 ```
 
 This lib is integrated into 
@@ -113,12 +113,25 @@ If you like the project, please
 ## Installation and Upgrade
 The module requires Python 3.7.0 or above. 
 
+For Anaconda we offer packages only from Python version 3.8 and higher.
+
 For the PyPy interpreter we offer packages only from Python version 3.9 and higher.
 
 The current dependencies are listed 
 [here](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/blob/master/requirements.txt).
 
-If you run into errors during the installation take a look [here](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/wiki/Installation).
+If you run into errors during the installation take a look [here](https://github.com/LUCIT-Systems-and-Development/unicorn-binance-suite/wiki/Installation).
+
+### Packages are created automatically with GitHub Actions
+When a new release is to be created, we start two GitHubActions: 
+
+- [Build and Publish Anaconda](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/actions/workflows/build_conda.yml)
+- [Build and Publish GH+PyPi](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/actions/workflows/build_wheels.yml) 
+
+Both start virtual Windows/Linux/Mac servers provided by GitHub in the cloud with preconfigured environments and 
+create the respective compilations and stub files, pack them into wheels and conda packages and then publish them on 
+GitHub, PYPI and Anaconda. This is a transparent method that makes it possible to trace the source code behind a 
+compilation.
 
 ### A Cython binary, PyPy or source code based CPython wheel of the latest version with `pip` from [PyPI](https://pypi.org/project/unicorn-binance-rest-api/)
 Our [Cython](https://cython.org/) and [PyPy](https://www.pypy.org/) Wheels are available on [PyPI](https://pypi.org/), 
@@ -173,9 +186,9 @@ Run in bash:
 `pip install https://github.com/LUCIT-Systems-and-Development/unicorn-fy/archive/$(curl -s https://api.github.com/repos/lucit-systems-and-development/unicorn-fy/releases/latest | grep -oP '"tag_name": "\K(.*)(?=")').tar.gz --upgrade`
 
 #### Windows
-Use the below command with the version (such as 1.14.1) you determined [here](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/releases/latest):
+Use the below command with the version (such as 0.14.2) you determined [here](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/releases/latest):
 
-`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-fy/archive/1.14.1.tar.gz --upgrade`
+`pip install https://github.com/LUCIT-Systems-and-Development/unicorn-fy/archive/0.14.2.tar.gz --upgrade`
 
 ### From the latest source (dev-stage) with PIP from [GitHub](https://github.com/LUCIT-Systems-and-Development/unicorn-fy)
 This is not a release version and can not be considered to be stable!
@@ -194,16 +207,14 @@ or the [current master branch](https://github.com/LUCIT-Systems-and-Development/
 - ./setup.py
 
 ## Change Log
-[https://unicorn-fy.docs.lucit.tech//CHANGELOG.html](https://unicorn-fy.docs.lucit.tech//CHANGELOG.html)
+[https://unicorn-fy.docs.lucit.tech/changelog.html](https://unicorn-fy.docs.lucit.tech/changelog.html)
 
 ## Documentation
 - [General](https://unicorn-fy.docs.lucit.tech/)
 - [Modules](https://unicorn-fy.docs.lucit.tech/modules.html)
 
 ## Examples
-- [example_logging.py](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/blob/master/example_logging.py)
-- [example_unicorn_fy.py](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/blob/master/example_unicorn_fy.py)
-- [example_version_of_this_package.py](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/blob/master/example_version_of_this_package.py)
+- [Look here!](https://github.com/LUCIT-Systems-and-Development/unicorn-fy/tree/master/examples/)
 
 ## Project Homepage
 [https://www.lucit.tech/unicorn-fy.html](https://www.lucit.tech/unicorn-fy.html)

docs/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 28186c005d890febfe51aa147511105e
+config: c0b45cae33dd30d1c08ae05876f1273d
 tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_modules/index.html

@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>Overview: module code &#8212; unicorn-fy 1.14.1 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>Overview: module code &#8212; unicorn-fy 0.14.2 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
 
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=92fd9be5" />
     <link rel="stylesheet" type="text/css" href="../_static/pydoctheme.css?v=fdf8e9ae" />
@@ -248,7 +248,7 @@ <h3>Navigation</h3>
     <a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
     &copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on Mar 14 2024 at 11:45 (CET).
+    Last updated on May 09 2024 at 21:03 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.

docs/_modules/unicorn_fy/unicorn_fy.html

@@ -4,7 +4,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>unicorn_fy.unicorn_fy &#8212; unicorn-fy 1.14.1 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title>unicorn_fy.unicorn_fy &#8212; unicorn-fy 0.14.2 documentation</title><meta name="viewport" content="width=device-width, initial-scale=1.0">
 
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=92fd9be5" />
     <link rel="stylesheet" type="text/css" href="../../_static/pydoctheme.css?v=fdf8e9ae" />
@@ -211,7 +211,7 @@ <h1>Source code for unicorn_fy.unicorn_fy</h1><div class="highlight"><pre>
 <span class="sd">        - Binance.org</span>
 <span class="sd">        - Jex.com</span>
 <span class="sd">    &quot;&quot;&quot;</span>
-    <span class="n">VERSION</span> <span class="o">=</span> <span class="s2">&quot;1.14.1.dev&quot;</span>
+    <span class="n">VERSION</span> <span class="o">=</span> <span class="s2">&quot;0.14.2&quot;</span>
 
     <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">debug</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">last_update_check_github</span> <span class="o">=</span> <span class="p">{</span><span class="s1">&#39;timestamp&#39;</span><span class="p">:</span> <span class="n">time</span><span class="o">.</span><span class="n">time</span><span class="p">(),</span>
@@ -221,11 +221,11 @@ <h1>Source code for unicorn_fy.unicorn_fy</h1><div class="highlight"><pre>
                         <span class="sa">f</span><span class="s2">&quot;</span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="n">platform</span><span class="o">.</span><span class="n">system</span><span class="p">())</span><span class="si">}</span><span class="s2"> </span><span class="si">{</span><span class="nb">str</span><span class="p">(</span><span class="n">platform</span><span class="o">.</span><span class="n">release</span><span class="p">())</span><span class="si">}</span><span class="s2"> started ...&quot;</span><span class="p">)</span>
 
     <span class="k">def</span> <span class="fm">__enter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
-        <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Entering &#39;with-context&#39; ...&quot;</span><span class="p">)</span>
+        <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Entering with-context of UnicornFy() ...&quot;</span><span class="p">)</span>
         <span class="k">return</span> <span class="bp">self</span>
 
     <span class="k">def</span> <span class="fm">__exit__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">exc_type</span><span class="p">,</span> <span class="n">exc_value</span><span class="p">,</span> <span class="n">error_traceback</span><span class="p">):</span>
-        <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Leaving &#39;with-context&#39; ...&quot;</span><span class="p">)</span>
+        <span class="n">logger</span><span class="o">.</span><span class="n">debug</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;Leaving with-context of UnicornFy() ...&quot;</span><span class="p">)</span>
         <span class="k">if</span> <span class="n">exc_type</span><span class="p">:</span>
             <span class="n">logger</span><span class="o">.</span><span class="n">critical</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;An exception occurred: </span><span class="si">{</span><span class="n">exc_type</span><span class="si">}</span><span class="s2"> - </span><span class="si">{</span><span class="n">exc_value</span><span class="si">}</span><span class="s2"> - </span><span class="si">{</span><span class="n">error_traceback</span><span class="si">}</span><span class="s2">&quot;</span><span class="p">)</span>
 
@@ -1680,7 +1680,7 @@ <h3>Navigation</h3>
     <a href="https://docs.lucit.tech">Index of all LUCIT Software Documentation</a><br />
     &copy; <a href="/license.html">Copyright</a> 2023-2023, LUCIT Systems and Development. All Rights Reserved..
     See <a href="/license.html">License</a> for more information.<br />
-    Last updated on Mar 14 2024 at 11:45 (CET).
+    Last updated on May 09 2024 at 20:42 (CET).
     <a href="https://github.com/LUCIT-Systems-and-Development/unicorn-fy/issues/new/choose">Found a bug</a>?
     <br />
     Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 7.2.6.