Pyramid (web framework)

Pyramid (web framework)
Name	Pyramid
Developer	Pylons Project
Initial release	2008
Latest release	1.10.10
Written in	Python
Operating system	Cross-platform
License	BSD
Website	https://trypyramid.com

Pyramid (web framework) is a lightweight, flexible Python web framework originating from the Pylons Project and designed for both small applications and large systems. It emphasizes minimalism, explicit configuration, and composability so developers can choose components such as templating engines, authentication, and persistence. Pyramid is used in contexts ranging from academic prototypes to enterprise deployments and integrates with many libraries and tools familiar in the Python ecosystem.

Overview

Pyramid was created within the milieu shaped by Python (programming language), the Pylons (web framework), and ideas from Zope and TurboGears, embracing influences from Django (web framework) and Flask (web framework) while maintaining distinct goals. Its architecture supports URL dispatch and traversal influenced by Zope Corporation conventions and paired with configuration patterns seen in Paste (software). Pyramid applications commonly use templating systems like Jinja (template engine), Mako (templating), and Chameleon (templating), and integrate with ORMs such as SQLAlchemy, ZODB, and Peewee. The project aligns with packaging and distribution practices from Setuptools, pip, and PyPI and interoperates with servers like Gunicorn, uWSGI, and Waitress.

History and Development

Pyramid's roots trace to the consolidation of components from Pylons (web framework) and the reorganization under the Pylons Project alongside projects like WebOb and Paste. Early development involved contributors associated with MySQL AB, Rackspace, and academic projects influenced by MIT research groups. Releases and governance have been influenced by community processes similar to those used by Python Software Foundation projects and adopted practices from Apache Software Foundation-style collaboration. Over time, Pyramid evolved in parallel with trends set by Django (web framework), shifts in Amazon Web Services deployment models, and tooling advances arising from Travis CI, GitHub, and Jenkins (software). Major design decisions responded to patterns popularized by RESTful architecture proponents and discussions at conferences such as PyCon and EuroPython.

Architecture and Features

Pyramid is built on a minimal core that composes middleware from WSGI-compatible components including WebOb and PasteDeploy. Its routing supports both explicit traversal and route declaration echoing ideas from Zope traversal and Ruby on Rails routing conventions. Authentication and authorization frameworks in Pyramid can be configured with policies similar to those used by OAuth and OpenID integrations, and session management may hook into backends like Memcached and Redis. The framework supports templating with systems comparable to Jinja (template engine), Mako (templating), and Chameleon (templating), and form handling patterns seen in WTForms and validation strategies akin to Colander. Pyramid's configuration system connects with ConfigParser-style files and leverages PasteDeploy INI semantics, while its extension points echo the plugin architectures of Zope and Trac (software). Testing workflows typically use pytest, unittest, and continuous integration with GitHub Actions or Travis CI.

Installation and Usage

Pyramid installs via pip from Python Package Index and follows packaging conventions from Setuptools and virtualenv or venv. A minimal application scaffolding can be created using cookiecutter-style templates and commands inspired by Bootstrap (front-end framework) project templates and community generators used at PyCon tutorials. Deployment options span WSGI servers such as Gunicorn, uWSGI, and Waitress and can be containerized using Docker or orchestrated via Kubernetes. Developers often combine Pyramid with databases like PostgreSQL, MySQL, SQLite, and MongoDB and use migration tools patterned after Alembic and Flyway approaches. Debugging and profiling integrate with tools from New Relic, Sentry (software), and Python profilers discussed at EuroPython and PyCon sessions.

Extensions and Ecosystem

Pyramid's ecosystem includes authentication add-ons, templating adapters, and integration modules registered on PyPI and showcased in repositories on GitHub. Notable complementary projects include Cornice for building REST services, Deform for forms, Colander for schema validation, and pyramid_debugtoolbar for interactive debugging similar to tools in Django (web framework). Add-ons support connectivity to services like LDAP, OAuth, SAML, and cloud platforms such as Amazon Web Services and Google Cloud Platform. Community contributions often mirror ecosystems from Flask (web framework) and Django (web framework), while corporate adoption patterns resemble integration strategies used by companies like Red Hat, Canonical (company), and IBM.

Adoption and Notable Projects

Pyramid has been used by academic labs, startups, and enterprises with deployments alongside infrastructures from Amazon Web Services, Microsoft Azure, and Google Cloud Platform. Organizations exploring Pyramid have included contributors from Mozilla Corporation, Dropbox, and research groups affiliated with MIT and Stanford University. Examples of projects using Pyramid have appeared in case studies relating to content management, APIs for bioinformatics collaborations with institutions like NIH, and internal tools at companies referenced at PyCon talks. The framework's flexibility makes it suitable for projects requiring bespoke routing, custom authentication, and integration with systems such as Elasticsearch, RabbitMQ, and Redis.

Category:Python web frameworks