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.9.0.tar.gz (16.2 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.9.0-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyramid_traversal_api-0.9.0.tar.gz
  • Upload date:
  • Size: 16.2 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.9.0.tar.gz
Algorithm Hash digest
SHA256 be47fce789bf9a39f51c8a25fd7c2d1112ba7b0aa8a668a87eb63dd135a6eacb
MD5 4f300e1e2df17a93811f65629560c844
BLAKE2b-256 624b7b962f814d455cb3e6332ae78dd5b2f5f304d7c1f88e70a36f5ff515cd1a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyramid_traversal_api-0.9.0-py3-none-any.whl
  • Upload date:
  • Size: 21.2 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.9.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f919a6cce49fe0734b6f3b88245f4742d97ecfb6a7d2483484a262b136345ec8
MD5 51e07086c9a39b24face049b322231d5
BLAKE2b-256 e54f5add3bc4af82dc0127214e223e062f8e5377f292b0ce0e3454791fb7cb6f

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