Skip to content

Installation

Requirements

  • Python 3.11 or higher
  • No external dependencies for core functionality

Install from PyPI

pip install qlcore-lib

Optional Dependencies

Monitoring

For system metrics and performance monitoring:

pip install qlcore-lib[monitoring]

This adds:

  • psutil for memory and CPU metrics
  • get_metrics() and timed_operation() utilities

Development

For contributing or running tests:

pip install qlcore-lib[dev]

This adds:

  • pytest and pytest-cov for testing
  • ruff for linting
  • black for formatting
  • mypy for type checking

Install from Source

git clone https://github.com/ZENTCH-Q/qlcore.git
cd qlcore
pip install -e .

For development with all tools:

pip install -e .[dev,monitoring]

Verify Installation

import qlcore as qc
print(qc.__version__)  # Should print "0.4.0" or current version

Quick functionality check:

import qlcore as qc

# Create a simple portfolio
portfolio = qc.crypto_portfolio(initial_balance=1000)
print(portfolio.account.balances)  # {'USDT': Decimal('1000')}

IDE Support

qlcore includes a py.typed marker for PEP 561 compliance. Type checkers and IDEs with Python support will provide:

  • Autocompletion for all public APIs
  • Type hints for function parameters and returns
  • Inline documentation from docstrings

Install the Pylance extension for full type support.

Works out of the box with Python plugin.

Next Steps