c1s-slingshot-sdk-py 0.4.0

Slingshot SDK

Capital One Slingshot SDK Python Library

• Capital One Slingshot SDK Python Library
  • Quick Start
  • Development Setup
  • Contribution Guidelines
    • Documentation
    • Releases
    • Commit Message Guidelines
  • CLI
  • Developer Interface
  • Configuration

Quick Start

To get started with the Slingshot SDK, you can use the provided Makefile for easy setup:

make bootstrap

This single command will:

• Install uv if not already available
• Create a virtual environment
• Install all dependencies
• Set up pre-commit hooks
• Run the test suite

Development Setup

The project uses a Makefile to streamline common development tasks. Here are the available commands:

Bootstrap Everything

make bootstrap

Complete project setup - this is what you want to run first!

Individual Setup Steps

make install-uv      # Install uv package manager if not found
make setup-venv      # Create virtual environment with uv
make sync            # Sync dependencies with uv
make test            # Run tests across all Python versions
make install-precommit # Install pre-commit hooks

Testing Commands

make test                    # Run tests across all Python versions (3.9-3.13)
make test 3.11               # Run tests for specific Python version
make test 3.11 lowest        # Run tests with specific Python version and dependency resolution
make test 3.11 highest       # Run tests with specific Python version and highest dependency resolution
make check                   # Run full CI pipeline locally (lint, typecheck, test)

The testing system automatically handles different Python versions and dependency resolutions using uv, ensuring compatibility across your supported environment matrix.

Utility Commands

make clean           # Clean up build artifacts and cache files
make help            # Show all available commands

Commit Message Guidelines

When contributing to this project, please use the Conventional Commit style for naming your commits. This ensures consistency and helps with automated versioning and changelog generation.

A commit message should follow this format:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Types

• feat: A new feature
• fix: A bug fix
• docs: Documentation changes
• style: Code style changes (formatting, missing semi-colons, etc.)
• refactor: Code restructuring without changing functionality
• test: Adding or updating tests
• chore: Maintenance tasks (e.g., updating dependencies)

Examples

• feat: add support for Python 3.13
• fix: resolve issue with dependency resolution
• docs: update README with commit guidelines

For more details, refer to the Conventional Commit Specification.