Package Health Score

45 / 100

security
Security review needed
popularity
Small
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Popularity

Small

GitHub Stars: 2.85K
Forks: 772
Contributors: 40

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package ibquant, we found that it has been starred 2,847 times.

Security

Security review needed

Security and license risk for latest version

Release Date: Sep 2, 2022
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
4
M
0
L

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

License

BSD-2-Clause

Security Policy

We found a way for you to contribute to the project! Looks like ibquant is missing a security policy.

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

archived

Commit Frequency

Open Issues: 18
Open PR: 3
Last Release: 2 years ago
Last Commit: 9 months ago

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

An important project maintenance signal to consider for ibquant is that it hasn't seen any new versions released to PyPI in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

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: No
Code of Conduct: No
Contributors: 40
Funding: Yes

With more than 10 contributors for the ibquant repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like ibquant is missing a Code of Conduct.

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.10.*

Age: 2 years
Latest Release: 2 years ago
Dependencies: 21 Direct / 130 Total
Versions: 2
Maintainers: 1
Wheels: OS Independent

Readme

IB Quant

A command line interface and Python framework for the Interactive Brokers APIs.

Overview

IB Quant leverages ib-insync to interface with Interactive Brokers TWS or Gateway.

The CLI is named ib.

After installing ibquant, ib's command groups can be shown in terminal with:

ib --help

For now, the CLI mostly serves to replace pytest as qualifying tests that a function or method is working as intended before including in a script. Most CLI commands replicate tasks that can be easily accomplished in the TWS platform.

The end goal is that these CLI commands come together in a high level command such as ib trader run --strategy=some_strategy_name.py to have core.Trader run the given strategy and perform appropriate pre, intra, and post trade reporting (logging) requirements, if any.

Core Classes and Mixin Interfaces

core.AppBase serves as a base for all other core classes

core.Trader drives a user defined strategy in live trading

core.Brute enables brute force optimization of rules based trading strategies

core.Learner is used to optimize gradient based learning strategies

mixins.AccountMixins enables account features for non-advisor accounts

mixins.AdvisorMixins enables features for an advisor account (groups, model portfolios)

mixins.ConnectionMixins handles the connection to the running TWS or Gateway sesion

mixins.ContractMixins provides an extended class to define contracts for the TWS API

mixins.DataMixins provides utilities for fetching historical data, and for streaming top of book or limit order book data.

mixins.OrderMixins provides interfaces for several TWS order types

mixins.StrategyMixins provides a base class for user defined strategies

> core.Learner should be used with my ML template, lightning-pod

Installation

The package can be installed for standard use or for development.

Required dependencies for standard use as a package are shown in setup.cfg under install_requires of the options group.

Dev dependencies are shown in setup.cfg under the options.extras_require group.

Installing the package for standard use

ibquant is available via PyPi with pip. Installation can be done with:

conda

conda env create -n ibquant python -y
conda activate ibquant
pip install ibquant

venv

cd {{ path to your project }}
python3 -m venv .venv/
# Activate the environment
# Linux and MacOS
source .venv/bin/activate
# Windows
.venv\Scripts\activate.bat
# install the package
pip install ibquant

Installing the package for development

After cloning the repo, the framework can be installed for development with:

# creating a virtual environment
cd {{ path to ibquant clone }}
python3 -m venv .venv/
# Activate the environment
# Linux and MacOS
source .venv/bin/activate
# Windows
.venv\Scripts\activate.bat
# install an editable version of the package
pip install -e ".[dev]"

Usage

After installing ibquant, log into a TWS paper account and test example flows from terminal with:

ib advisor managed-accounts

ib account summary

ib contract lookup --contract-type=Future

Each of the above commands will prompt the user for required inputs.

> localSymbol, multiplier, and currency prompts of ib contract lookup are not required

Ecosystem

Aside from using ib-insync, ibtrader also provides users with:

QuantLib
alphalens-reloaded: community maintained version of Quantopian alphalens
empyrical-reloaded: community maintained version of Quantopian empyrical
pyfolio-reloaded: community maintained version of Quantopian pyfolio
zipline-reloaded: community maintained version of Quantopian zipline
nasdaq-data-link: formerly known as Quandl
PyEX: an IEX Cloud API tool
TA-Lib: a technical analysis library common to PyEX and Zipline

Factors, Indicators, Studies, Strategies

Zipline Reloaded provides factors and indicators in the pipeline API. TA-Lib is installed as a dependency of Zipline. Most factors and indicators of both libraries will be reachable via ibtrader.factors.

Indicator definitions can be found at:

Trading Technologies Glossary
thinkorswim Studies Library
IBKR Technical Analytics Guide

Sample strategies can be found via the link below.

thinkorswim Strategies Library

FAQs

What is ibquant?

A Python Framework for Interactive Brokers TWS API. Visit Snyk Advisor to see a full health score report for ibquant, including popularity, security, maintenance & community analysis.

Is ibquant popular?

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

Is ibquant well maintained?

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

Is ibquant safe to use?

While scanning the latest version of ibquant, we found that a security review is needed. A total of 0 vulnerabilities or license issues were detected. See the full security scan results.

Last updated on 21 November-2024, at 01:39 (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