unofficial-tabdeal-api 0.1.5

a Package to communicate with Tabdeal platform

Package
Documentation
Tests
Linters
License
Stats
Misc

a Package to communicate with Tabdeal platform

Features

• TODO

Requirements

• aiohttp

Installation

You can install unofficial tabdeal api via pip from PyPI:

pip install unofficial-tabdeal-api

Usage

# Initialize aiohttp.ClientSession asynchronously
async with aiohttp.ClientSession() as client_session:

    # Create a TabdealClient object inside the async wrap
    my_client: TabdealClient = TabdealClient(USER_HASH, USER_AUTHORIZATION_KEY, client_session)

    # Run your desired commands, remember to `await` the methods as all of them (except a few) are asynchronous
    bomeusdt_asset_id = await my_client.get_margin_asset_id("BOMEUSDT")

Learn more at the Documentation.

Issues

• Most exceptions are caught broadly using the except Exception as exception, This raises Pylint-W0718, but i currently don’t have a fix for it.

• Some parts of the code works flawlessly but raises Pylance-reportCallIssue, Pylance-reportArgumentType or Mypy-call-overload which i mitigate by adding # type: ignore at the end of the line. This must be investigated later and fixed with a proper solution. I don’t know a solution for it yet.

If you encounter any problems, please file an issue along with a detailed description.

TODO

• Fix Pylint-W0718 by catching specific exceptions instead of catching all exceptions.

• Fix Pylance-reportCallIssue, Pylance-reportArgumentType or Mypy-call-overload.

• Fix missing library stubs or py.typed marker MyPy-import-untyped.

• Improve documentation for setup and usage.

• Use python built-in TypeGuard (3.10+) as a pre-processor on server responses to mitigate Type issues. (TypeGuard example) (Type Narrowing)

• Configure Sphinx thoroughly.

• Tidelift?

• Automatic stub generation and stub testing (stubgen & stubtest)

• Sharded benchmarking (Pytest parallel benching | Github parallel benching)

• Use https://shields.io/badges/git-hub-deployments for showing deployment status

License

Distributed under the terms of the MIT license, unofficial tabdeal api is free and open source software.

Contributing

Contributions are welcome. To learn more, see the Contributor Guide.

Credits

This project was created with the help of @cjolowicz’s Hypermodern Python Cookiecutter template and @fpgmaas’s Cookiecutter Poetry template.