No project description provided
Project description
mountaineer-cloud
Shared cloud primitives for Python webservices, in particular ones built off of Mountaineer or FastAPI.
Most webapps themselves are cloud-agnostic and can be distributed within any Linux environment. This works pretty well when your whole application is stateless and just talks to a database, but falls down once you actually start needing infrastructure that spawns across your whole cluster. This package exists for the places where that abstraction breaks down and you still need a clean way to work with a real supplier:
- Object storage
- Email delivery
The package is organized around three layers:
mountaineer_cloud.providers: provider-specific configuration, authentication, and dependency injectionmountaineer_cloud.providers_common: shared provider-side storage runtime codemountaineer_cloud.primitives: the user-facing primitives you actually use in application code
Installation
Install the package as usual. If you want additional dependencies to mock (some) providers locally, also install the mocks extra:
uv add "mountaineer-cloud"
uv add --dev "mountaineer-cloud[mocks]"
Primitives
The user-facing primitives currently live under mountaineer_cloud.primitives.
Today those include:
CloudFileCloudFileFieldCloudMixinEmailMessageEmailRecipient
The storage primitives are the primary implemented surface today. The core convention is:
- A provider package establishes how to connect to the real supplier.
- That provider exposes an authenticated
*Coreobject. - A primitive accepts that core object and uses it to perform work.
For storage, that means your field annotation carries the provider core type:
from fastapi import Depends
from iceaxe import Field, TableBase
from mountaineer_cloud import CloudMixin
from mountaineer_cloud.primitives import CloudFile, CloudFileField
from mountaineer_cloud.providers.aws import AWSCore, AWSDependencies
class Asset(CloudMixin, TableBase):
id: int = Field(primary_key=True)
file_url: CloudFile[AWSCore] | None = CloudFileField(
bucket="my-bucket",
prefix="assets",
)
async def upload_asset(
asset: Asset,
aws: AWSCore = Depends(AWSDependencies.get_aws_core),
):
await asset.file_url.put_content(aws, b"hello world")
contents = await asset.file_url.get_content(aws)
return contents
If you later move that same model or endpoint to another provider, the primitive API stays the same. Thanks to the magic of typehinting, we'll proactively flag errors if you're trying to use a backend provider that doesn't support the functionality you expect. The main thing that changes is the core type:
CloudFile[AWSCore]CloudFile[CloudflareCore]CloudFile[DigitalOceanCore]
Providers
Each provider module establishes the concrete connection details for an underlying supplier.
Every provider package follows the same pattern:
*Config: the settings model you inherit into your downstream app config*Core: the authenticated runtime object that combines provider config with an authenticated session*Dependencies: dependency-injected helpers likeget_*_core, useful when using the DI syntax of FastAPI and Mountaineer
This is the center of the convention.
Your endpoint should depend on the provider core, not on a raw client or session. Then your primitive should accept that core and perform the actual work. This keeps supplier-specific connection logic inside the provider package and keeps the primitive surface stable.
AWS
Import AWSConfig into your downstream application config and inherit from it:
from mountaineer_cloud.providers.aws import AWSConfig
class AppConfig(AWSConfig):
APP_NAME: str = "my-app"
This adds the AWS settings required by the provider:
AWS_ACCESS_KEYAWS_SECRET_KEYAWS_REGION_NAMEAWS_ROLE_ARNAWS_ROLE_SESSION_NAME
Then inject AWSCore where you need to talk to AWS-backed primitives:
from fastapi import Depends
from mountaineer_cloud.providers.aws import AWSCore, AWSDependencies
async def endpoint(
aws: AWSCore = Depends(AWSDependencies.get_aws_core),
):
...
Cloudflare
Import CloudflareConfig into your downstream application config and inherit from it:
from mountaineer_cloud.providers.cloudflare import CloudflareConfig
class AppConfig(CloudflareConfig):
APP_NAME: str = "my-app"
This adds the Cloudflare R2 settings required by the provider:
R2_ACCESS_KEY_IDR2_SECRET_ACCESS_KEYR2_ACCOUNT_ID
Then inject CloudflareCore where you need to talk to Cloudflare-backed primitives:
from fastapi import Depends
from mountaineer_cloud.providers.cloudflare import (
CloudflareCore,
CloudflareDependencies,
)
async def endpoint(
cloudflare: CloudflareCore = Depends(CloudflareDependencies.get_cloudflare_core),
):
...
DigitalOcean
Import DigitalOceanConfig into your downstream application config and inherit from it:
from mountaineer_cloud.providers.digitalocean import DigitalOceanConfig
class AppConfig(DigitalOceanConfig):
APP_NAME: str = "my-app"
This adds the Spaces settings required by the provider:
SPACES_ACCESS_KEY_IDSPACES_SECRET_ACCESS_KEYSPACES_REGION
Then inject DigitalOceanCore where you need to talk to DigitalOcean-backed primitives:
from fastapi import Depends
from mountaineer_cloud.providers.digitalocean import (
DigitalOceanCore,
DigitalOceanDependencies,
)
async def endpoint(
digitalocean: DigitalOceanCore = Depends(
DigitalOceanDependencies.get_digitalocean_core
),
):
...
Storage Notes
CloudFile is intentionally a string-backed type so it still stores cleanly in ORMs like Iceaxe, while also carrying the methods needed to read and write remote content.
CloudFileField(...) defines the storage configuration for the pointer itself:
bucketprefixsuffixcompressionstorage_backend
CloudMixin is the model-side glue that binds those field definitions back onto runtime values. It exists because CloudFileField(...) is instantiated in global scope, before the field has access to the resolved model type hint or the eventual model instance via self.
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mountaineer_cloud-0.1.0.tar.gz.
File metadata
- Download URL: mountaineer_cloud-0.1.0.tar.gz
- Upload date:
- Size: 964.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.8.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c70eed19e24528a7f9d7ad1b3f7c815c400d071cfde829d743da52ce777e12be
|
|
| MD5 |
e0ad4eea05bcabbea3599627602afedd
|
|
| BLAKE2b-256 |
15c436e7741de5165d5cdefc2d92bb4706b7c0e3678227d8cdcbcb1b1d29962a
|
File details
Details for the file mountaineer_cloud-0.1.0-py3-none-any.whl.
File metadata
- Download URL: mountaineer_cloud-0.1.0-py3-none-any.whl
- Upload date:
- Size: 36.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.8.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
73d4b0e4b34d535e074389077ac9be64ec0c7f99daf6352ef6cd75b8d6fa0b91
|
|
| MD5 |
9c7f84256d4d6e522436be9eb17cb2f9
|
|
| BLAKE2b-256 |
5b4c82f7660160a357d7a68efb8139d3e30a291f0681a2890e4a5b8db7e303c5
|