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.8.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.8.0-py3-none-any.whl (21.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyramid_traversal_api-0.8.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.8.0.tar.gz
Algorithm Hash digest
SHA256 7ebee482bb27713b8fcd929b89577011021679aec95c90af883013740b651a1e
MD5 53ceeceefa3c7e1090d48900453b5331
BLAKE2b-256 6531187ab55f3cf3852fbc129322bf6d2ab2e40876031be8e6a6924f12b038e3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyramid_traversal_api-0.8.0-py3-none-any.whl
  • Upload date:
  • Size: 21.3 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.8.0-py3-none-any.whl
Algorithm Hash digest
SHA256 211e9c386f1deaa2bfbb6ecfd77264f365ab2132b42592d9ca760b0ae6560f9c
MD5 5eae0b563b5a192a23e7b9ba2ec5b51f
BLAKE2b-256 903d32554a62a979a4e0ecd8ebc20bc26aa8c715526a0e21fdf9ae8da3fe5025

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