FastPubSub Versions¶

FastPubSub enables developers to push systems to production quickly with embedded features. The project also moves fast—new features are added frequently, bugs are fixed regularly, and the code continuously improves.

The current versions are 0.x.x, reflecting that each version could potentially have breaking changes. Like FastAPI, FastPubSub follows Semantic Versioning conventions.

You can create production applications with the latest version, but pay attention to the guidelines below.

Pin Your Version¶

Pin the version of FastPubSub you're using to a specific version that works correctly for your application.

# Static pin: Replace 0.4.0 with your current version
fastpubsub==0.4.0

# Range pin: Replace 0.4 with your current minor version
fastpubsub>=0.4.0,<0.5.0

The range pin avoids breaking changes but gets patches and fixes (e.g., 0.4.1, 0.4.2).

If you use tools like uv, poetry, or pipenv, they all have ways to define specific version constraints.

Upgrading: Always Test¶

Having a suite of automated unit and integration tests is essential when upgrading library versions.

With tests, you can:

1. Safely upgrade fastpubsub to a more recent version
2. Run your tests to ensure everything works correctly
3. Pin the dependency to the new version if tests pass

Documentation Code Conventions¶

To maintain consistency across all documentation and examples, we follow these conventions:

Standard Placeholders¶

Standard Variable Names¶

Example¶

from fastpubsub import FastPubSub, PubSubBroker, Message

broker = PubSubBroker(project_id="your-project-id")
app = FastPubSub(broker)

@broker.subscriber(
    alias="user-handler",
    topic_name="user-events",
    subscription_name="user-events-subscription",
)
async def handle_message(message: Message):
    print(f"Processing message: {message.id}")

These conventions ensure code examples are clear, consistent, and easy to understand.

Changelog¶

For detailed changes in each version, see the GitHub Releases page.