unicorn-fy

v0.14.2

A Python SDK by LUCIT to convert received raw data from crypto exchange API endpoints into well-formed python dictionaries. For more information about how to use this package see README

Latest version published 8 months ago

License: MIT

PyPI

GitHub

Package Health Score

65 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Popularity

Small

GitHub Stars: 54
Forks: 20
Contributors: 6

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package unicorn-fy, we found that it has been starred 54 times.

Security

No known security issues

Security and license risk for latest version

Release Date: May 9, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

MIT

Security Policy

Yes

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

Open Issues: 7
Open PR: 0
Last Release: 8 months ago
Last Commit: 3 months ago

Further analysis of the maintenance status of unicorn-fy based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

We found that unicorn-fy demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Sustainable

Readme: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 6
Funding: Yes

This project has seen only 10 or less contributors.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.7.0

Age: 4 years
Latest Release: 8 months ago
Dependencies: 3 Direct
Versions: 13
Maintainers: 0
Wheels: Linux, macOS, Musllinux, Windows

Readme

Anaconda Release Anaconda Downloads

UnicornFy

A Python SDK by LUCIT to convert received raw data from crypto exchange API endpoints into well-formed python dictionaries.

Part of 'UNICORN Binance Suite'.

Get help with the integration of the UNICORN Binance Suite modules from the UNICORN Binance Suite Assistant GPT or a real human LUCIT employee.

import unicorn_fy

received_stream_data_json = {"stream": "btcusdt@trade",
                             "data": {"e": "trade",
                                      "E": 1556876873656,
                                      "s": "BTCUSDT",
                                      "t": 117727701,
                                      "p": "5786.76000000",
                                      "q": "0.03200500",
                                      "b": 341831847,
                                      "a": 341831876,
                                      "T": 1556876873648,
                                      "m": True,
                                      "M": True}}

ufy = unicorn_fy.UnicornFy()

unicorn_fied_stream_data = ufy.binance_com_websocket(received_stream_data_json)
print(unicorn_fied_stream_data)

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', '0.14.2']}

This lib is integrated into UNICORN Binance WebSocket API and can be activated by setting parameter output_default of BinanceWebSocketApiManager() to UnicornFy or for specific streams with the parameter output of create_stream() to UnicornFy.

Get the right logger:

logging.getLogger("unicorn_fy")

Supported Exchanges

Websockets

Exchange	Docs	Status
Binance (API)	`binance_com_websocket(stream_data_json)`	STABLE
Binance Testnet (API)	`binance_com_websocket(stream_data_json)`	STABLE
Binance Margin (API)	`binance_com_margin_websocket(stream_data_json)`	STABLE
Binance Margin Testnet (API)	`binance_com_margin_websocket(stream_data_json)`	STABLE
Binance Isolated Margin (API)	`binance_com_isolated_margin_websocket(stream_data_json)`	STABLE
Binance Isolated Margin Testnet (API)	`binance_com_isolated_margin_websocket(stream_data_json)`	STABLE
Binance Futures (API)	`binance_com_futures_websocket(stream_data_json)`	STABLE
Binance Futures Testnet (API)	`binance_com_futures_websocket(stream_data_json)`	STABLE
Binance Coin Futures (API)	`binance_com_coin_futures_websocket(stream_data_json)`	NEEDS_YOUR_HELP
Binance Coin Futures Testnet (API)	`binance_com_coin_futures_websocket(stream_data_json)`	NEEDS_YOUR_HELP
Binance Jersey (API)	`binance_je_websocket(stream_data_json)`	STABLE
Binance US (API)	`binance_us_websocket(stream_data_json)`	STABLE
Binance TR (API)	`trbinance_com_websocket(stream_data_json)`	STABLE
Binance JEX (API)	`jex_com_websocket(stream_data_json)`	STABLE
Binance DEX (API)	`binance_org_websocket(stream_data_json)`	NEEDS_YOUR_HELP
Binance DEX Testnet (API)	`binance_org_websocket(stream_data_json)`	NEEDS_YOUR_HELP

REST

none

If you like the project, please it on GitHub!

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.

If you run into errors during the installation take a look here.

Packages are created automatically with GitHub Actions

When a new release is to be created, we start two GitHubActions:

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

Our Cython and PyPy Wheels are available on PyPI, these wheels offer significant advantages for Python developers:

Performance Boost with Cython Wheels: Cython is a programming language that supplements Python with static typing and C-level performance. By compiling Python code into C, Cython Wheels can significantly enhance the execution speed of Python code, especially in computationally intensive tasks. This means faster runtimes and more efficient processing for users of our package.
PyPy Wheels for Enhanced Efficiency: PyPy is an alternative Python interpreter known for its speed and efficiency. It uses Just-In-Time (JIT) compilation, which can dramatically improve the performance of Python code. Our PyPy Wheels are tailored for compatibility with PyPy, allowing users to leverage this speed advantage seamlessly.

Both Cython and PyPy Wheels on PyPI make the installation process simpler and more straightforward. They ensure that you get the optimized version of our package with minimal setup, allowing you to focus on development rather than configuration.

On Raspberry Pi and other architectures for which there are no pre-compiled versions, the package can still be installed with PIP. PIP then compiles the package locally on the target system during installation. Please be patient, this may take some time!

Installation

pip install unicorn-fy

Update

pip install unicorn-fy --upgrade

A Conda Package of the latest version with `conda` from Anaconda

The unicorn-fy package is also available as a Cython version for the linux-64, osx-64 and win-64 architectures with Conda through the lucit channel.

For optimal compatibility and performance, it is recommended to source the necessary dependencies from the conda-forge channel.

Installation

conda config --add channels conda-forge
conda config --add channels lucit
conda install -c lucit unicorn-fy

Update

conda update -c lucit unicorn-fy

From source of the latest release with PIP from Github

Linux, macOS, ...

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 0.14.2) you determined here:

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

This is not a release version and can not be considered to be stable!

pip install https://github.com/LUCIT-Systems-and-Development/unicorn-fy/tarball/master --upgrade

Conda environment, Virtualenv or plain Python

Download the latest release or the current master branch and use:

./environment.yml
./meta.yaml
./pyproject.toml
./requirements.txt
./setup.py

Change Log

https://unicorn-fy.docs.lucit.tech/changelog.html

Documentation

Examples

Look here!

Project Homepage

https://www.lucit.tech/unicorn-fy.html

Wiki

https://github.com/LUCIT-Systems-and-Development/unicorn-fy/wiki

Social

Receive Notifications

To receive notifications on available updates you can the repository on GitHub, write your own script with using is_update_available() or you use the monitoring API service.

How to report Bugs or suggest Improvements?

List of planned features - click thumbs-up if you need one of them or suggest a new feature!

Before you report a bug, try the latest release. If the issue still exists, provide the error trace, OS and python version and explain how to reproduce the error. A demo script is appreciated.

If you dont find an issue related to your topic, please open a new issue: https://github.com/LUCIT-Systems-and-Development/unicorn-fy/issues

Report a security bug!

Contributing

UnicornFy is an open source project which welcomes contributions which can be anything from simple documentation fixes and reporting dead links to new features. To contribute follow this guide.

Contributors

We love open source!

Disclaimer

This project is for informational purposes only. You should not construe this information or any other material as legal, tax, investment, financial or other advice. Nothing contained herein constitutes a solicitation, recommendation, endorsement or offer by us or any third party provider to buy or sell any securities or other financial instruments in this or any other jurisdiction in which such solicitation or offer would be unlawful under the securities laws of such jurisdiction.

If you intend to use real money, use it at your own risk!

Under no circumstances will we be responsible or liable for any claims, damages, losses, expenses, costs or liabilities of any kind, including but not limited to direct or indirect damages for loss of profits.

Commercial Support

Do you need a developer, operator or consultant? Contact us for a non-binding initial consultation!

unicorn-fy dependencies

cython requests ujson

FAQs

What is unicorn-fy?

A Python SDK by LUCIT to convert received raw data from crypto exchange API endpoints into well-formed python dictionar... Visit Snyk Advisor to see a full health score report for unicorn-fy, including popularity, security, maintenance & community analysis.

Is unicorn-fy popular?

The python package unicorn-fy receives a total of 9,180 weekly downloads. As such, unicorn-fy popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is unicorn-fy well maintained?

We found indications that unicorn-fy is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is unicorn-fy safe to use?

The python package unicorn-fy was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 21 December-2024, at 03:21 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Direct Usage Popularity

Security and license risk for latest version

Commit Frequency

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Snyk Vulnerability Scanner

Readme

UnicornFy

Get the right logger:

Supported Exchanges

Websockets

REST

Installation and Upgrade

Packages are created automatically with GitHub Actions

A Cython binary, PyPy or source code based CPython wheel of the latest version with pip from PyPI

Installation

Update

A Conda Package of the latest version with conda from Anaconda

Installation

Update

From source of the latest release with PIP from Github

Linux, macOS, ...

Windows

From the latest source (dev-stage) with PIP from GitHub

Conda environment, Virtualenv or plain Python

Change Log

Documentation

Examples

Project Homepage

Wiki

Social

Receive Notifications

How to report Bugs or suggest Improvements?

Contributing

Contributors

Disclaimer

If you intend to use real money, use it at your own risk!

Commercial Support

unicorn-fy dependencies

FAQs

What is unicorn-fy?

Is unicorn-fy popular?

Is unicorn-fy well maintained?

Is unicorn-fy safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues

A Cython binary, PyPy or source code based CPython wheel of the latest version with `pip` from PyPI

A Conda Package of the latest version with `conda` from Anaconda