Skip to main content

reddit's python service framework

Project description

baseplate.py

It's much easier to manage a bunch of services when they all have the same shape: the way they're developed, the way they interact with the infrastructure they run on, and the way they interact with each other. Baseplate is reddit's specification for the common shape of our services. This library, Baseplate.py, is the Python implementation of that specification.

Baseplate.py glues together tooling for interacting with the reddit backend ecosystem and spackles over things that are missing. It integrates with Apache Thrift, Pyramid, and client libraries for many systems to transparently make your applications observable.

Baseplate applications transparently get:

  • Timing and request rate metrics using statsd
  • Distributed tracing with Zipkin
  • Error reporting and aggregation with Sentry

And can take advantage of:

  • Integration with commonly used clients like: Thrift, SQLAlchemy, cassandra-driver, pymemcache, redis-py, and Kombu
  • Secrets securely pulled from Vault

And many other things!

pre-commit

This repo comes with pre-commit hooks that let you (on a voluntary basis) enable pre-commit and/or pre-push hooks.

Configuration can be found at the root of the directory in .pre-commit-config.yaml. On its own, the configuration file doesn't do anything. You either need to run the hooks manually or install them so that they run automatically on every commit or push.

Currently, we run the make fmt target on commit and make lint / pytest actions on push.

Specific hooks can be temporarily disabled.

You can install hooks only for a specific step (i.e. pre-push).

Testing in Snoodev

You can upgrade any service to use in development Baseplate code in Snoodev by editing the requirements file for the service you would like to use for testing. Update the the Baseplate requirement to pull from Github instead, like this:

diff --git a/requirements.txt b/requirements.txt
index aef8ad8..d32a078 100644
--- a/requirements.txt
+++ b/requirements.txt
-baseplate==2.5.7
+git+https://github.com/reddit/baseplate.py@<ref>#egg=baseplate

In this case the ref can be either a commit hash or a branch name. After making this update you can check if the service works in Snoodev.

Warning Never deploy this change to production. Production should always use a Baseplate semantic version that has been tagged, and released.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

baseplate-2.7.1.tar.gz (142.5 kB view details)

Uploaded Source

Built Distribution

baseplate-2.7.1-py3-none-any.whl (191.0 kB view details)

Uploaded Python 3

File details

Details for the file baseplate-2.7.1.tar.gz.

File metadata

  • Download URL: baseplate-2.7.1.tar.gz
  • Upload date:
  • Size: 142.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.10.12 Linux/6.5.0-1025-azure

File hashes

Hashes for baseplate-2.7.1.tar.gz
Algorithm Hash digest
SHA256 97356d73b684759c887a69302acbca93953a6be564585ee48927a59440673a1e
MD5 8d6f9e7912804b529f5cce2a9e9e74b7
BLAKE2b-256 39062cdd2ba6d82e9f5dd7f76a06e068c8b546c1cd04fe29acdd8d0a4d85edea

See more details on using hashes here.

File details

Details for the file baseplate-2.7.1-py3-none-any.whl.

File metadata

  • Download URL: baseplate-2.7.1-py3-none-any.whl
  • Upload date:
  • Size: 191.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.2 CPython/3.10.12 Linux/6.5.0-1025-azure

File hashes

Hashes for baseplate-2.7.1-py3-none-any.whl
Algorithm Hash digest
SHA256 24a2bc8f8a862397c3b614273807f39ee8cd629ba163b9e93a339f3bbd9b9bb5
MD5 8f4d2316318ffe4ae107296ecc0742bd
BLAKE2b-256 4041209bbceb014e34b0d6fd9b7ecb4cb6d30fba2e4bc9616b8ce590118aefe4

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page