stpstone (short for stepping stone) is a Python framework designed for ingesting, processing, and analyzing structured and unstructured financial data. It provides tools for ETL (Extract, Transform, Load), quantitative analysis, and derivatives pricing, optimized for financial market applications.
Pyenv: Installation Guide
Makefile (below are some benefits of usage)
| Category | Example Targets | Benefit |
|---|---|---|
| Package Lifecycle | build_package_pypi_org, clean_dist | Automated PyPI publishing |
| Git Workflows | git_pull_force, gh_protect_main | Enforces branch policies |
| CI/CD | gh_actions_local_tests | Local pipeline validation |
| Code Generation | ingestion_concrete_creator | Factory pattern automation |
| Dev Environment | vscode_setup | Consistent IDE setup |
Makefile Installation Options for Windows:
Makefile Installation for MacOS:
Makefile Installation for Ubuntu: Preinstalled, no action needed
Option 1: Pip Install (Recommended) 📌 Available on PyPI
#!/bin/bash
pip install stpstone
Option 2: Build from Source
#!/bin/bash
git clone https://github.com/guilhermegor/stpstone.git
cd stpstone
pyenv install 3.12.8
pyenv local 3.12.8
poetry install --no-root
poetry shell
Setting Up Make (Optional for Build Automation)
| Platform | Instructions |
|---|---|
| Windows | Install via MinGW 1. Download MinGW installer 2. Select mingw32-make during installation3. Add C:\MinGW\bin to PATH4. mingw32-make --version |
| MacOS | Pre-installed or via Xcode CLI tools:xcode-select --install |
| Linux | Install via package manager:sudo apt-get install build-essential |
Python Kernel Versioning (Pyenv): pyenv instructions to installation
Execute unit and integration tests:
#!/bin/bash
poetry run python -m unittest discover -s tests/unit -p "*.py" -v
poetry run python -m unittest discover -s tests/integration -p "*.py" -v
stpstone/
│
├── 📁 .github/
│ ├── 📁 workflows/ # GitHub Actions CI/CD pipelines
│ ├── 📜 CODEOWNERS # Code ownership definitions
│ └── 📜 PULL_REQUEST_TEMPLATE.md # PR template
│
├── 📁 .vscode/ # VSCode configuration
│ └── ⚙️ settings.json # Editor preferences and extensions
│
├── 📁 cli/ # Command Line Interface components
│
├── 📁 data/ # Data storage and management
│
├── 📁 docs/ # Project documentation
│
├── 📁 examples/ # Example implementations
│
├── 📁 img/ # Visual assets
│
├── 📁 stpstone/ # Core Python package
│ ├── 📁 _config/ # Configuration management
│ ├── 📁 analysis/ # Analytical components
│ ├── 📁 dsa/ # Data structures & algorithms
│ ├── 📁 ingestion/ # Data ingestion pipelines
│ ├── 📁 transformations/ # Data transformation logic
│ ├── 📁 utils/ # Shared utilities
│ └── 🐍 __init__.py # Package initialization
│
├── 📁 tests/ # Test suites
│ ├── 📁 unit/ # Unit tests
│ ├── 📁 integration/ # Integration tests
│ └── 📁 performance/ # Performance benchmarking
│
├── 📜 .gitignore # Git ignore patterns
├── ⚙️ .pre-commit-config.yaml # Pre-commit hook configurations
├── � .python-version # Pyenv version specification
├── 📜 LICENSE # MIT License file
├── ⚙️ Makefile # Automation tasks
├── 📦 poetry.lock # Exact dependency versions
├── ⚙️ pyproject.toml # Project metadata and dependencies
├── 📖 README.md # Project overview
├── 📦 requirements.txt # Production dependencies
├── 🔧 requirements-dev.txt # Development dependencies
└── 💻 requirements-venv.txt # Virtual environment setup
Guilherme Rodrigues
This project is licensed under the MIT License - see LICENSE for details.
Inspired by open-source financial libraries and tools
This documentation follows a structure inspired by PurpleBooth's README-Template.md.
Special thanks to Python community
FAQs
Solid financial ETL, analytics and utils with support to global markets.
We found that stpstone demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
TC39 advances 11 JavaScript proposals, with two moving to Stage 4, bringing better math, binary APIs, and more features one step closer to the ECMAScript spec.
Research
/Security News
A flawed sandbox in @nestjs/devtools-integration lets attackers run code on your machine via CSRF, leading to full Remote Code Execution (RCE).
Product
Customize license detection with Socket’s new license overlays: gain control, reduce noise, and handle edge cases with precision.
