py-ibkr 0.1.0__tar.gz

py_ibkr-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,35 @@
+name: "CI"
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+          - "3.10"
+          - "3.11"
+          - "3.12"
+          - "3.13"
+          - "3.14"
+      fail-fast: false
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --all-extras --dev
+
+      - name: Run tests
+        run: uv run pytest

py_ibkr-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,33 @@
+name: "Publish"
+# https://docs.astral.sh/uv/guides/integration/github/#publishing-to-pypi
+
+on:
+  push:
+    tags:
+      # Publish on any tag starting with a `v`, e.g., v0.1.0
+      - v*
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+      - name: Install Python 3.12
+        run: uv python install 3.12
+      - name: Build
+        run: uv build
+      # Check that basic features work and we didn't miss to include crucial files
+      - name: Smoke test (wheel)
+        run: uv run --isolated --no-project --with dist/*.whl tests/smoke_test.py
+      - name: Smoke test (source distribution)
+        run: uv run --isolated --no-project --with dist/*.tar.gz tests/smoke_test.py
+      - name: Publish
+        run: uv publish

py_ibkr-0.1.0/.gitignore

@@ -0,0 +1,293 @@
+### VisualStudioCode template
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### JetBrains template
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
+
+# User-specific stuff
+.idea/**/workspace.xml
+.idea/**/tasks.xml
+.idea/**/usage.statistics.xml
+.idea/**/dictionaries
+.idea/**/shelf
+
+# AWS User-specific
+.idea/**/aws.xml
+
+# Generated files
+.idea/**/contentModel.xml
+
+# Sensitive or high-churn files
+.idea/**/dataSources/
+.idea/**/dataSources.ids
+.idea/**/dataSources.local.xml
+.idea/**/sqlDataSources.xml
+.idea/**/dynamic.xml
+.idea/**/uiDesigner.xml
+.idea/**/dbnavigator.xml
+
+# Gradle
+.idea/**/gradle.xml
+.idea/**/libraries
+
+# Gradle and Maven with auto-import
+# When using Gradle or Maven with auto-import, you should exclude module files,
+# since they will be recreated, and may cause churn.  Uncomment if using
+# auto-import.
+# .idea/artifacts
+# .idea/compiler.xml
+# .idea/jarRepositories.xml
+# .idea/modules.xml
+# .idea/*.iml
+# .idea/modules
+# *.iml
+# *.ipr
+
+# CMake
+cmake-build-*/
+
+# Mongo Explorer plugin
+.idea/**/mongoSettings.xml
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Cursive Clojure plugin
+.idea/replstate.xml
+
+# SonarLint plugin
+.idea/sonarlint/
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Editor-based Rest Client
+.idea/httpRequests
+
+# Android studio 3.1+ serialized cache file
+.idea/caches/build_file_checksums.ser
+
+### macOS template
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+/.idea/inspectionProfiles/profiles_settings.xml
+/.idea/inspectionProfiles/Project_Default.xml
+/.idea/.gitignore
+/.idea/json_assistant_history.xml
+/.idea/misc.xml
+/.idea/modules.xml
+/.idea/pydantic-ib.iml
+/.idea/vcs.xml

py_ibkr-0.1.0/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.1.0] - 2026-02-05
+
+### Added
+- Initial release of `py-ibkr`.
+- Pydantic models for IBKR Flex Query.
+- Parser for XML Flex Query reports.
+- Support for Trade and CashTransaction models.
+- OSS packaging standards (LICENSE, MANIFEST.in, py.typed).
+- GitHub Actions for CI and PyPI publication.

py_ibkr-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Roman Medvedev
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

py_ibkr-0.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+global-exclude *.py[cod]
+global-include *.typed

py_ibkr-0.1.0/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: py-ibkr
+Version: 0.1.0
+Summary: A modern, Pydantic-based parser for Interactive Brokers (IBKR) Flex Query reports
+Project-URL: Homepage, https://github.com/romamo/py-ibkr
+Project-URL: Repository, https://github.com/romamo/py-ibkr
+Project-URL: Issues, https://github.com/romamo/py-ibkr/issues
+Author-email: Roman Medvedev <pypi@romavm.dev>
+License: MIT
+License-File: LICENSE
+Keywords: finance,flex-query,ibkr,interactive-brokers,pydantic
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: pydantic>=2.0
+Provides-Extra: dev
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: types-python-dateutil; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# py-ibkr
+
+A modern, Pydantic-based parser for Interactive Brokers (IBKR) Flex Query reports.
+This version replaces the legacy `ibflex` library with strict type checking and improved support for newer IBKR XML fields.
+
+## Features
+- **Pydantic Models**: All data is parsed into typed Pydantic models with validation.
+- **Robust Parsing**: Handles "messy" IBKR data (e.g., legacy enums like `Deposits/Withdrawals`, inconsistent date formats).
+- **Forward Compatible**: Designed to handle new fields gracefully.
+
+## Installation
+
+```bash
+uv pip install py-ibkr
+# or
+pip install py-ibkr
+```
+
+## Usage
+
+### Parsing a Flex Query File
+
+```python
+from py_ibkr import parse, FlexQueryResponse
+
+response = parse("path/to/report.xml")
+
+print(f"Query Name: {response.queryName}")
+
+for statement in response.FlexStatements:
+    print(f"Account: {statement.accountId}")
+    
+    # Access Trades
+    for trade in statement.Trades:
+        print(f"Symbol: {trade.symbol}, Quantity: {trade.quantity}, Price: {trade.tradePrice}")
+        
+    # Access Cash Transactions
+    for cash_tx in statement.CashTransactions:
+        print(f"Type: {cash_tx.type}, Amount: {cash_tx.amount}")
+```
+
+### Models
+
+You can import models directly for type hinting:
+
+```python
+from py_ibkr import Trade, CashTransaction
+
+def process_trade(trade: Trade):
+    print(trade.symbol)
+```

py_ibkr-0.1.0/README.md

@@ -0,0 +1,51 @@
+# py-ibkr
+
+A modern, Pydantic-based parser for Interactive Brokers (IBKR) Flex Query reports.
+This version replaces the legacy `ibflex` library with strict type checking and improved support for newer IBKR XML fields.
+
+## Features
+- **Pydantic Models**: All data is parsed into typed Pydantic models with validation.
+- **Robust Parsing**: Handles "messy" IBKR data (e.g., legacy enums like `Deposits/Withdrawals`, inconsistent date formats).
+- **Forward Compatible**: Designed to handle new fields gracefully.
+
+## Installation
+
+```bash
+uv pip install py-ibkr
+# or
+pip install py-ibkr
+```
+
+## Usage
+
+### Parsing a Flex Query File
+
+```python
+from py_ibkr import parse, FlexQueryResponse
+
+response = parse("path/to/report.xml")
+
+print(f"Query Name: {response.queryName}")
+
+for statement in response.FlexStatements:
+    print(f"Account: {statement.accountId}")
+    
+    # Access Trades
+    for trade in statement.Trades:
+        print(f"Symbol: {trade.symbol}, Quantity: {trade.quantity}, Price: {trade.tradePrice}")
+        
+    # Access Cash Transactions
+    for cash_tx in statement.CashTransactions:
+        print(f"Type: {cash_tx.type}, Amount: {cash_tx.amount}")
+```
+
+### Models
+
+You can import models directly for type hinting:
+
+```python
+from py_ibkr import Trade, CashTransaction
+
+def process_trade(trade: Trade):
+    print(trade.symbol)
+```

py_ibkr-0.1.0/examples/parse_report.py

@@ -0,0 +1,41 @@
+"""
+Example script to parse an IBKR Flex Query XML file.
+"""
+
+from pathlib import Path
+
+from py_ibkr import parse
+
+
+def main():
+    # Attempt to locate sample file
+    # In a real scenario, provide your own path
+    sample_path = Path("path/to/report.xml")
+
+    if not sample_path.exists():
+        print(f"Sample file not found at {sample_path}")
+        return
+
+    print(f"Parsing {sample_path}...")
+    try:
+        response = parse(str(sample_path))
+        print("Successfully parsed.")
+        print("-" * 30)
+
+        for stmt in response.FlexStatements:
+            print(f"Account: {stmt.accountId}")
+            print(f"Trades Count: {len(stmt.Trades)}")
+            print(f"Cash Tx Count: {len(stmt.CashTransactions)}")
+
+            if stmt.Trades:
+                last_trade = stmt.Trades[-1]
+                print(
+                    f"Last Trade: {last_trade.buySell.value} {last_trade.quantity} {last_trade.symbol} @ {last_trade.tradePrice}"
+                )
+
+    except Exception as e:
+        print(f"Error parsing file: {e}")
+
+
+if __name__ == "__main__":
+    main()

py_ibkr-0.1.0/pyproject.toml

@@ -0,0 +1,53 @@
+[project]
+name = "py-ibkr"
+version = "0.1.0"
+description = "A modern, Pydantic-based parser for Interactive Brokers (IBKR) Flex Query reports"
+readme = "README.md"
+authors = [
+    { name = "Roman Medvedev", email = "pypi@romavm.dev" },
+]
+license = { text = "MIT" }
+requires-python = ">=3.10"
+keywords = ["ibkr", "pydantic", "flex-query", "interactive-brokers", "finance"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Office/Business :: Financial :: Investment",
+]
+
+dependencies = [
+    "pydantic>=2.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "ruff",
+    "mypy",
+    "types-python-dateutil",
+    "pytest",
+]
+
+[project.urls]
+Homepage = "https://github.com/romamo/py-ibkr"
+Repository = "https://github.com/romamo/py-ibkr"
+Issues = "https://github.com/romamo/py-ibkr/issues"
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B"]
+ignore = []
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

py_ibkr-0.1.0/src/py_ibkr/__init__.py

@@ -0,0 +1,3 @@
+from .flex import CashTransaction, FlexQueryResponse, FlexStatement, Trade, parse
+
+__all__ = ["parse", "FlexQueryResponse", "FlexStatement", "Trade", "CashTransaction"]

py_ibkr-0.1.0/src/py_ibkr/flex/__init__.py

@@ -0,0 +1,7 @@
+from .models import CashTransaction as CashTransaction
+from .models import FlexQueryResponse as FlexQueryResponse
+from .models import FlexStatement as FlexStatement
+from .models import Trade as Trade
+from .parser import parse_xml_file as parse
+
+__all__ = ["FlexQueryResponse", "FlexStatement", "Trade", "CashTransaction", "parse"]