Skip to main content

QFF: Quantize Financial Framework

PyPI Python Docker Image Version (latest by date) Documentation Status

QFF is a Python package of quantitative financial framework, which is used to provide a localized backtesting and simulation trading environment for individuals, so that users can focus more on trading strategy writing.

Main Features

Here are just a few of the things that QFF does well:

  • Provide one-stop solutions such as data crawling, data cleaning, data storage, strategy writing, strategy analysis, strategy backtest and simulated trade.
  • Provide graceful interface for strategy writing (similar to JoinQuant), facilitate users to get started quickly.
  • Provide a local running environment to improve the strategy running efficiency.
  • Provide rich interfaces to obtain free stock data, such as fundamental data, real-time and historical market data etc.
  • Provide practical auxiliary functions to simplify strategy writing, such as indicator calculation, trading system framework, etc.

Installation

Source code

The source code is currently hosted on GitHub at: https://github.com/haijiangxu/qff

General

pip install qff --upgrade

China

pip install qff -i http://mirrors.aliyun.com/pypi/simple/ --upgrade

Docker

Docker image for the QFF is at https://hub.docker.com/r/haijiangxu/qff.

pull docker image

docker pull qff

run docker image

docker run -d -v /root/xxxx:/root/work -p 8765:8765  qff

Document

Documentation for the latest Current release is at https://qff.readthedocs.io/zh_CN/latest/.

Contribution

QFF is still under developing, feel free to open issues and pull requests:

  • Report or fix bugs
  • Require or publish interface
  • Write or fix documentation
  • Add test cases

Statement

  1. QFF only supports stocks, but not other financial products such as futures, funds, foreign exchange, bonds, cryptocurrencies, etc.
  2. All data provided by QFF is just for academic research purpose.
  3. The data provided by QFF is for reference only and does not constitute any investment proposal.
  4. Any investor based on QFF research should pay more attention to data risk.
  5. QFF will insist on providing open-source financial data.
  6. Based on some uncontrollable factors, some data interfaces in QFF may be removed.
  7. Please follow the relevant open-source protocol used by QFF.

Acknowledgement

Special thanks QUANTAXIS for the opportunity of learning from the project;

Special thanks AKShare for the opportunity of learning from the project;

Special thanks JoinQuant for the opportunity of learning from the project;

Metadata

Release files for qff 0.5.19

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for qff 0.5.19
File Size Uploaded
qff-0.5.19.tar.gz 150.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for qff 0.5.19
File Interpreter ABI Platform
qff-0.5.19-py3-none-any.whl Python 3 none any Details

Total release size: 346.0 kB

Release files / qff-0.5.19.tar.gz

Download URL qff-0.5.19.tar.gz
Size 150.4 kB
Tags Source
SHA-256 checksum
How to use checksums
726d0f25c62d104bb14bcbb587fa5a309b9767b7ac21b6306c8c6aea05bbe514
BLAKE2b-256 checksum
How to use checksums
3b6b379d4ff2cfce9e31e7b792854557655a0d87e724e16283296d74d7a3005a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.8.10

Release files / qff-0.5.19-py3-none-any.whl

Download URL qff-0.5.19-py3-none-any.whl
Size 195.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3e949b8c3f0f377c8e243954895aff60b0014817d1508c4b82032a16f01f45b0
BLAKE2b-256 checksum
How to use checksums
095454950933a1d360728a9ea65cfcc89f8929b306652ff9270c2524ed73fe4e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.8.10
Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page