Skip to main content

A library that allows you to easily mock out tests based on AWS infrastructure

Project description

Moto - Mock AWS Services

Join the chat at https://gitter.im/awsmoto/Lobby

Build Status Coverage Status Docs PyPI PyPI - Python Version PyPI - Downloads Code style: Ruff Financial Contributors

Install

$ pip install 'moto[ec2,s3,all]'

In a nutshell

Moto is a library that allows your tests to easily mock out AWS Services.

Imagine you have the following python code that you want to test:

import boto3


class MyModel:
    def __init__(self, name, value):
        self.name = name
        self.value = value

    def save(self):
        s3 = boto3.client("s3", region_name="us-east-1")
        s3.put_object(Bucket="mybucket", Key=self.name, Body=self.value)

Take a minute to think how you would have tested that in the past.

Now see how you could test it with Moto:

import boto3
from moto import mock_aws
from mymodule import MyModel


@mock_aws
def test_my_model_save():
    conn = boto3.resource("s3", region_name="us-east-1")
    # We need to create the bucket since this is all in Moto's 'virtual' AWS account
    conn.create_bucket(Bucket="mybucket")
    model_instance = MyModel("steve", "is awesome")
    model_instance.save()
    body = conn.Object("mybucket", "steve").get()["Body"].read().decode("utf-8")
    assert body == "is awesome"

With the decorator wrapping the test, all the calls to s3 are automatically mocked out. The mock keeps track of the state of the buckets and keys.

For a full list of which services and features are covered, please see our implementation coverage.

Documentation

The full documentation can be found here:

http://docs.getmoto.org/en/latest/

Financial Contributions

Support this project and its continued development, by sponsoring us!

Click the Sponsor-button at the top of the page for more information.

Our finances are managed by OpenCollective, which means you have full visibility into all our contributions and expenses: https://opencollective.com/moto

Security contact information

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

Project details


Release history Release notifications | RSS feed

This version

5.1.8

Download files

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

Source Distribution

moto-5.1.8.tar.gz (7.0 MB view details)

Uploaded Source

Built Distribution

moto-5.1.8-py3-none-any.whl (5.1 MB view details)

Uploaded Python 3

File details

Details for the file moto-5.1.8.tar.gz.

File metadata

  • Download URL: moto-5.1.8.tar.gz
  • Upload date:
  • Size: 7.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for moto-5.1.8.tar.gz
Algorithm Hash digest
SHA256 5c2f63c051b7c13224cb1483917c85a796468d7e37dcd5d1a5b8de66729de3f4
MD5 64e4f60347fcb2aea52bbb94fc18a1c5
BLAKE2b-256 19e8986b38d3459124168e21b8ea3311a9a26e930bc84b1e9ede16e5bccd574c

See more details on using hashes here.

Provenance

The following attestation bundles were made for moto-5.1.8.tar.gz:

Publisher: release.yml on getmoto/moto

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file moto-5.1.8-py3-none-any.whl.

File metadata

  • Download URL: moto-5.1.8-py3-none-any.whl
  • Upload date:
  • Size: 5.1 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for moto-5.1.8-py3-none-any.whl
Algorithm Hash digest
SHA256 12f3a15100da7de019c671a516dbba33b14072faba103f16ca79a39b8c803b7d
MD5 4ab3638b294a0ca993e0389728fb8d21
BLAKE2b-256 f1a97dc06460777b2c1e7a91bb485e9dd600a88331aeac73ca88a8a6d437900f

See more details on using hashes here.

Provenance

The following attestation bundles were made for moto-5.1.8-py3-none-any.whl:

Publisher: release.yml on getmoto/moto

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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