Metadata-Version: 2.4
Name: pyramid_traversal_api
Version: 0.1.0
Summary: Tools for writing REST APIs in Pyramid using the traversal API
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Pyramid
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Dist: marshmallow
Requires-Dist: pyramid
Requires-Dist: ruff ; extra == 'dev'
Requires-Dist: sphinx ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: pytest-mock ; extra == 'dev'
Requires-Dist: webtest>=3.0.7 ; extra == 'dev'
Requires-Dist: sqlalchemy ; extra == 'sqla'
Requires-Python: >=3.10
Provides-Extra: dev
Provides-Extra: sqla
Description-Content-Type: text/markdown

# pyramid-traversal-api

**NOTE** This library is currently WIP. Expect breakages, even between minor versions, while on major version 0.

A set of helpers that makes it easier to write traversal-based REST APIs for [pyramid](https://trypyramid.com/) with modern QoL features like

 * Request/response validation
 * Automatic OpenAPI
 * Automatic SQLAlchemy requests
   - But possible to write your own support for any backend
 * Built around writing REST APIs

## Design goals

 * Build tools FOR pyramid, not REPLACING pyramid
   - No new abstraction layers on top of Pyramid, just new building blocks
 * Easy to slap on top of an existing project, allowing gradual migration
   - Start small finish big, like Pyramid

## Standing on the shoulder of giants

Thank you to the pylons project for Pyramid. Greetings also go to `Theron Luhn` for [pyramid-marshmallow](https://pypi.org/project/pyramid-marshmallow/), which the OpenAPI functionality of this package is based on.

## Requirements

Python 3.9 or later
