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.

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyramid_traversal_api-0.6.0.tar.gz
  • Upload date:
  • Size: 16.1 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.6.0.tar.gz
Algorithm Hash digest
SHA256 702180cf1480f3e9f9f772b0cfd99aaf5c212bbcdcaa23add4f5c32d82cfb1a7
MD5 2f9d76fc76421d6182b4c76351ec9cd2
BLAKE2b-256 7b4ea3d1b9fa25dc223a453b8ee48421190625ccadd897c7cd0da4ad0bc93f33

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyramid_traversal_api-0.6.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.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ddacb41517c926323fbc63c35a1506716d6cf4c4700e87d235a52c4cd16be371
MD5 aefa6ba4d426750a2c2022ff89b79795
BLAKE2b-256 4c6a51e998b9bc406149fcd147e4a6aeb24f3ccfae08f7634457b858fb4c4d61

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