Skip to main content

Tools for writing REST APIs in Pyramid using the traversal API

Project description

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 with modern QoL features like

  • Request/response validation
  • Automatic OpenAPI
  • Automatic SQLAlchemy requests
    • But possible to write your own support for any backend
  • An "industry standard" method for dealing with CORS
    • If by industry standard you mean a configurable version of CORS method that "every" Pyramid user uses
  • 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
  • Performance-first - Prefer doing heavy lifting (metaprogramming, etc) at initiatlization time.

Installing

Install pyramid_traversal_api

See https://pypi.org/project/pyramid_traversal_api/ for not.

Standing on the shoulder of giants

Thank you to the pylons project for Pyramid. Greetings also go to Theron Luhn for pyramid-marshmallow, which the OpenAPI functionality of this package is based on.

Requirements

Python 3.9 or later

Hacking

Unit tests require sqlalchemy. I use a test pyramid project for testing.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyramid_traversal_api-0.11.0.tar.gz (16.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyramid_traversal_api-0.11.0-py3-none-any.whl (21.4 kB view details)

Uploaded Python 3

File details

Details for the file pyramid_traversal_api-0.11.0.tar.gz.

File metadata

  • Download URL: pyramid_traversal_api-0.11.0.tar.gz
  • Upload date:
  • Size: 16.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for pyramid_traversal_api-0.11.0.tar.gz
Algorithm Hash digest
SHA256 293b91627364965070e98e999405c5918bd6a7cd46ab6f1f67f1d0d63d169f42
MD5 442502863708c2ad3a090edfd497f848
BLAKE2b-256 584b35c774568b4f4164b2a42a70fae109191c0b79a7078c437f501b2aba9b1a

See more details on using hashes here.

File details

Details for the file pyramid_traversal_api-0.11.0-py3-none-any.whl.

File metadata

  • Download URL: pyramid_traversal_api-0.11.0-py3-none-any.whl
  • Upload date:
  • Size: 21.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.16 {"installer":{"name":"uv","version":"0.11.16","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Arch Linux","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for pyramid_traversal_api-0.11.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b4a7a2c66ddbb2cb3cdac70a02164fec0db01f1087cb741cf88de5cc2c6d1ef3
MD5 7936a4859d37615ffedcb0ea9ad85162
BLAKE2b-256 c4ec074f604f961e3fb8c18f827b2e43162a3c7ac3d05abf8de392af0ea7fc9c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page