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

Uploaded Python 3

File details

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

File metadata

  • Download URL: pyramid_traversal_api-0.7.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.7.0.tar.gz
Algorithm Hash digest
SHA256 c97b919f0379582e4b134c66aa99eb02f55575088e444192f8c099407df5e9d9
MD5 10f31465d810647cbc9a4f4549b61e9f
BLAKE2b-256 159dbbec4fe8f1adb6b8e1325b45ea8c4c03d94ec7cf0eb39630a22adf853aab

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pyramid_traversal_api-0.7.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.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 feea844f22a66831d3f3c48cfaecbdb7cd9f2379f8f906f733a0ad222f08a23b
MD5 b2a3c0dfe86edb9b116e248ce44abd0d
BLAKE2b-256 c0b6119124d4c04ee5e3264737e725d808a413ebc4e641d50f2bf4ecdf6a0977

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