Metadata-Version: 2.4
Name: c1s-slingshot-sdk-py
Version: 2.0.0
Summary: Slingshot SDK
Author: Capital One Software
License-Expression: Apache-2.0
License-File: LICENSE
License-File: NOTICE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python
Requires-Dist: backoff>=2.2.1
Requires-Dist: httpx>=0.23
Requires-Dist: typing-extensions>=4.1.0
Requires-Dist: certifi>=2021.10.8
Requires-Dist: idna>=2.8
Requires-Dist: sniffio>=1.2.0
Requires-Dist: anyio>=2.0.0
Requires-Python: >=3.9, <3.14
Project-URL: Changelog, https://github.com/capitalone/c1s-slingshot-sdk-py/blob/main/docs/CHANGELOG.md
Project-URL: Home, https://github.com/capitalone/c1s-slingshot-sdk-py
Description-Content-Type: text/markdown

# Capital One Slingshot SDK Python Library

![Capital One Slingshot Logo](https://raw.githubusercontent.com/capitalone/c1s-slingshot-sdk-py/main/docs/_static/slingshot-small-logo.png)

The official Python SDK for Capital One's Slingshot platform. This library provides a convenient way to interact with the Slingshot API from your Python applications.

## 📚 Documentation

**➤ [Complete Documentation & API Reference](https://capitalone.github.io/c1s-slingshot-sdk-py/)**

For comprehensive guides, examples, and API documentation, visit our GitHub Pages documentation site.

## Table of Contents

- [Capital One Slingshot SDK Python Library](#capital-one-slingshot-sdk-python-library)
  - [📚 Documentation](#-documentation)
  - [Table of Contents](#table-of-contents)
  - [Installation](#installation)
  - [Quick Start](#quick-start)
  - [Contributing](#contributing)
  - [License](#license)

## Installation

Install the SDK using pip:

```bash
pip install c1s-slingshot-sdk-py
```

## Quick Start

```python
from slingshot import SlingshotClient

# Initialize the client (uses SLINGSHOT_API_KEY environment variable)
client = SlingshotClient()
# If you want to pass your API key to the client without using the environment variable:
# client = SlingshotClient(api_key="your API key")

# List projects
all_projects = []
for project in client.projects.iterate_projects():
    all_projects.append(project)

print(f"Found {len(all_projects)} projects.")

# Get a specific project
project = client.projects.get_project(all_projects[0]["id"])
print(project)
```

## Contributing

> [!IMPORTANT]
> At this time, we are only accepting pull requests from Capital One employees. External pull requests will be closed.

🔧 **[Contributing Guide](CONTRIBUTING.md)** - Development setup, testing, and release process

## License

This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details.
