Metadata-Version: 2.1
Name: python-vimeo-utils
Version: 0.1.0
Summary: Wrapper functions around pyvimeo for common interactions with the Vimeo SDK.
Author-email: Tim Santor <tsantor@xstudios.com>
Project-URL: Repository, https://github.com/tsantor/python-vimeo-utils.git
Project-URL: Issues, https://github.com/tsantor/python-vimeo-utils/issues
Project-URL: Changelog, https://github.com/tsantor/python-vimeo-utils/blob/master/HISTORY.md
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
License-File: AUTHORS.md
Requires-Dist: pyvimeo >=1.1.2
Provides-Extra: dev

# Python Vimeo Utils

![Coverage](https://img.shields.io/badge/coverage-93%25-brightgreen)

## Overview

An API wrapper around [pyvimeo](https://github.com/vimeo/vimeo.py) for common interactions with the Vimeo SDK with sane `fields` defaults. Vimeo loves to return **overly verbose** responses.

## Installation

Install Python Vimeo Utils:

```bash
python3 -m pip install python-vimeo-utils
```

## Usage
```python
import vimeo
from vimeo_utils import VimeoAPIClient

vclient = vimeo.VimeoClient(
    token="VIMEO_ACCESS_TOKEN",
    key="VIMEO_CLIENT_ID",
    secret="VIMEO_CLIENT_SECRET",
)

vapi_client = VimeoAPIClient(vclient)

vapi_client.get_video('/videos/1234567890')
```

<!-- ## Documentation
Visit the docs [here](https://github.io/tsantor/python-vimeo-utils/docs) -->

## Development
To get a list of all commands with descriptions simply run `make`.

```bash
make env
make pip_install
make pip_install_editable
```

## Testing

```bash
make pytest
make coverage
make open_coverage
```

## Issues

If you experience any issues, please create an [issue](https://github.com/tsantor/python-vimeo-utils/issues) on GitHub.

# History

All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/).

## 0.1.0 (2024-05-13)

- First release
