Skip to main content

FinancePype is a Python library for trading on centralized and decentralized exchanges.

Project description

Finance Pypeline

A Python framework for managing and executing trading operations across multiple platforms with a focus on reliability and consistency.

Overview

financepype is a modular trading framework designed to:

  • Handle multi-platform trading operations
  • Manage trading pairs and balances
  • Track operations and their states
  • Enforce trading rules and validations
  • Support both spot and perpetual trading

It is inspired by some of the concepts used in hummingbot, but with a focus on simplicity and flexibility.

Features

  • Multi-Platform Support: Seamlessly integrate with both centralized and decentralized exchanges
  • Advanced Order Management:
    • Support for various order types (Market, Limit)
    • Order modifiers (Post-Only, Reduce-Only, IOC, FOK)
    • Position management for derivatives trading
  • Asset Management:
    • Spot trading support
    • Perpetual futures trading
    • Options trading support
    • Blockchain asset integration
  • Balance Tracking:
    • Real-time balance updates
    • Multi-currency support
    • PnL tracking
  • Trading Rules Engine:
    • Customizable trading rules
    • Risk management constraints
    • Position sizing rules
  • Operation Tracking:
    • Order state management
    • Transaction tracking
    • Fee calculation and tracking

Installation

The package requires Python 3.13 or later. You can install it using Poetry:

poetry add financepype

Or with pip:

pip install financepype

Quick Start

Here's a simple example of how to use financepype:

from financepype.assets.factory import AssetFactory
from financepype.platforms.platform import Platform
from financepype.markets.trading_pair import TradingPair

# Initialize platform
platform = Platform(identifier="binance")

# Get assets
btc = AssetFactory.get_asset(platform, "BTC")
usdt = AssetFactory.get_asset(platform, "USDT")

# Create trading pair
trading_pair = TradingPair(name="BTC-USDT")

Development

Setup

  1. Clone the repository:
git clone https://github.com/gianlucapagliara/financepype.git
cd financepype
  1. Install dependencies with Poetry:
poetry install
  1. Set up pre-commit hooks:
poetry run pre-commit install

Testing

Run the test suite:

poetry run pytest

Code Quality

The project uses several tools to maintain code quality:

  • Black for code formatting
  • isort for import sorting
  • mypy for static type checking
  • ruff for linting
  • pre-commit hooks for automated checks

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

financepype-0.1.4.tar.gz (86.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

financepype-0.1.4-py3-none-any.whl (120.6 kB view details)

Uploaded Python 3

File details

Details for the file financepype-0.1.4.tar.gz.

File metadata

  • Download URL: financepype-0.1.4.tar.gz
  • Upload date:
  • Size: 86.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.13.1 Darwin/24.0.0

File hashes

Hashes for financepype-0.1.4.tar.gz
Algorithm Hash digest
SHA256 857aa7830a1ea8a85bc936a1e0b3b3319dd5c099206a6be00364224ca6760db1
MD5 23e97a03854cb6d83cdbb38abc78e55d
BLAKE2b-256 45540d9b15e465e26cbee4c9ae45aa0b3d041f18337902560a026397cff79092

See more details on using hashes here.

File details

Details for the file financepype-0.1.4-py3-none-any.whl.

File metadata

  • Download URL: financepype-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 120.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.0.1 CPython/3.13.1 Darwin/24.0.0

File hashes

Hashes for financepype-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e770a15666a7351103bda078badda422e20bc4473ca34adfeafca706d3696225
MD5 2b7bac348606ff685c6e59cddef5629c
BLAKE2b-256 5a0d33438942e6d9c11ca540c680c43799ffce20fb662754f673251bb5c0812d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page