project-x-py 0.2.0__tar.gz

project_x_py-0.2.0/.gitignore

@@ -0,0 +1,283 @@
+# 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/#use-with-ide
+.pdm.toml
+
+# 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 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/
+
+# VS Code
+.vscode/
+*.code-workspace
+
+# Sublime Text
+*.sublime-project
+*.sublime-workspace
+
+# Vim
+*.swp
+*.swo
+*~
+
+# Emacs
+*~
+\#*\#
+/.emacs.desktop
+/.emacs.desktop.lock
+*.elc
+auto-save-list
+tramp
+.\#*
+
+# macOS
+.DS_Store
+.AppleDouble
+.LSOverride
+Icon
+._*
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+# Windows
+Thumbs.db
+Thumbs.db:encryptable
+ehthumbs.db
+ehthumbs_vista.db
+*.tmp
+*.temp
+Desktop.ini
+$RECYCLE.BIN/
+*.cab
+*.msi
+*.msix
+*.msm
+*.msp
+*.lnk
+
+# Linux
+*~
+.fuse_hidden*
+.directory
+.Trash-*
+.nfs*
+
+# Project-specific
+config.json
+*.key
+*.pem
+*.crt
+*.p12
+*.jks
+secrets/
+private/
+
+# Trading/Financial data
+data/
+logs/
+backups/
+*.csv
+*.xlsx
+*.db
+
+# Temporary files
+tmp/
+temp/
+scratch/
+
+# IDE and editor files
+.idea/
+*.iml
+.project
+.pydevproject
+.settings/
+.classpath
+
+# Backup files
+*.bak
+*.backup
+*.orig
+*.save
+
+# Compiled documentation
+docs/build/
+docs/_build/
+docs/dist/
+
+# Local configuration files
+local_config.py
+local_settings.py
+.local/
+
+# API keys and secrets (project-specific patterns)
+*api_key*
+*secret*
+*password*
+*token*
+.env.local
+.env.development
+.env.test
+.env.production
+.env
+test.py

project_x_py-0.2.0/CHANGELOG.md

@@ -0,0 +1,162 @@
+# Changelog
+
+All notable changes to the ProjectX Python client will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.2.0] - 2025-01-28
+
+### Added
+- **Modular Architecture**: Split large monolithic file into logical modules
+  - `client.py` - Main ProjectX client class
+  - `models.py` - Data models and configuration
+  - `exceptions.py` - Custom exception hierarchy
+  - `utils.py` - Utility functions and helpers
+  - `config.py` - Configuration management
+- **Enhanced Error Handling**: Comprehensive exception hierarchy with specific error types
+  - `ProjectXAuthenticationError` for auth failures
+  - `ProjectXServerError` for 5xx errors
+  - `ProjectXRateLimitError` for rate limiting
+  - `ProjectXConnectionError` for network issues
+  - `ProjectXDataError` for data validation errors
+- **Configuration Management**: 
+  - Environment variable support with `PROJECTX_*` prefix
+  - JSON configuration file support
+  - Default configuration with overrides
+  - Configuration validation and templates
+- **Professional Package Structure**:
+  - Proper `pyproject.toml` with optional dependencies
+  - Comprehensive README with examples
+  - MIT license
+  - Test framework setup with pytest
+  - Development tools configuration (ruff, mypy, black)
+- **Enhanced API Design**:
+  - Factory methods: `ProjectX.from_env()`, `ProjectX.from_config_file()`
+  - Improved type hints throughout
+  - Better documentation and examples
+  - Consistent error handling patterns
+- **Utility Functions**:
+  - `setup_logging()` for consistent logging
+  - `get_env_var()` for environment variable handling
+  - `format_price()` and `format_volume()` for display
+  - `is_market_hours()` for market timing
+  - `RateLimiter` class for API rate limiting
+
+### Changed
+- **Breaking**: Restructured package imports - use `from project_x_py import ProjectX` instead of importing from `__init__.py`
+- **Breaking**: Configuration now uses `ProjectXConfig` dataclass instead of hardcoded values
+- **Improved**: Better error messages with specific exception types
+- **Enhanced**: Client initialization with lazy authentication
+- **Updated**: Package metadata and PyPI classifiers
+
+### Improved
+- **Documentation**: Comprehensive README with installation, usage, and examples
+- **Code Quality**: Improved type hints, docstrings, and code organization
+- **Testing**: Basic test framework with pytest fixtures and mocks
+- **Development**: Better development workflow with linting and formatting tools
+
+### Dependencies
+- **Core**: `polars>=1.31.0`, `pytz>=2025.2`, `requests>=2.32.4`
+- **Optional Realtime**: `signalrcore>=0.9.5`, `websocket-client>=1.0.0`
+- **Development**: `pytest`, `ruff`, `mypy`, `black`, `isort`
+
+## [0.1.0] - 2025-01-01
+
+### Added
+- Initial release with basic trading functionality
+- ProjectX Gateway API client
+- Real-time data management via WebSocket
+- Order placement, modification, and cancellation
+- Position and trade management
+- Historical market data retrieval
+- Multi-timeframe data synchronization
+
+### Features
+- Authentication with TopStepX API
+- Account management
+- Instrument search and contract details
+- OHLCV historical data with polars DataFrames
+- Real-time market data streams
+- Level 2 market depth data
+- Comprehensive logging
+
+---
+
+## Release Notes
+
+### Upgrading to v0.2.0
+
+If you're upgrading from v0.1.0, please note the following breaking changes:
+
+1. **Import Changes**:
+   ```python
+   # Old (v0.1.0)
+   from project_x_py import ProjectX
+   
+   # New (v0.2.0) - same import, but underlying structure changed
+   from project_x_py import ProjectX  # Still works
+   ```
+
+2. **Environment Variables**:
+   ```bash
+   # Required (same as before)
+   export PROJECT_X_API_KEY="your_api_key"
+   export PROJECT_X_USERNAME="your_username"
+   
+   # New optional configuration variables
+   export PROJECTX_API_URL="https://api.topstepx.com/api"
+   export PROJECTX_TIMEOUT_SECONDS="30"
+   export PROJECTX_RETRY_ATTEMPTS="3"
+   ```
+
+3. **Client Initialization**:
+   ```python
+   # Recommended new approach
+   client = ProjectX.from_env()  # Uses environment variables
+   
+   # Or with explicit credentials (same as before)
+   client = ProjectX(username="user", api_key="key")
+   
+   # Or with custom configuration
+   config = ProjectXConfig(timeout_seconds=60)
+   client = ProjectX.from_env(config=config)
+   ```
+
+4. **Error Handling**:
+   ```python
+   # New specific exception types
+   try:
+       client = ProjectX.from_env()
+       account = client.get_account_info()
+   except ProjectXAuthenticationError:
+       print("Authentication failed")
+   except ProjectXServerError:
+       print("Server error")
+   except ProjectXError:
+       print("General ProjectX error")
+   ```
+
+### Migration Guide
+
+1. **Update imports**: No changes needed - existing imports still work
+2. **Update error handling**: Consider using specific exception types
+3. **Use new factory methods**: `ProjectX.from_env()` is now recommended
+4. **Optional**: Set up configuration file for advanced settings
+5. **Optional**: Use new utility functions for logging and formatting
+
+### New Installation Options
+
+```bash
+# Basic installation (same as before)
+pip install project-x-py
+
+# With real-time features
+pip install project-x-py[realtime]
+
+# With development tools
+pip install project-x-py[dev]
+
+# Everything
+pip install project-x-py[all]
+``` 

project_x_py-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Jeff West
+
+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.