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

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.16.tar.gz (8.2 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

moto-5.1.16-py3-none-any.whl (6.3 MB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for moto-5.1.16.tar.gz
Algorithm Hash digest
SHA256 792045b345d16a8aa09068ad4a7656894e707c796f0799b438fffb738e8fae7c
MD5 8dea995b58da7dfdf13da661ca9c0a3b
BLAKE2b-256 330e346bdadba09fd86854fa3363892ca12f4232652c9d210b93c673c48807ea

See more details on using hashes here.

Provenance

The following attestation bundles were made for moto-5.1.16.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.16-py3-none-any.whl.

File metadata

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

File hashes

Hashes for moto-5.1.16-py3-none-any.whl
Algorithm Hash digest
SHA256 8e6186f20b3aa91755d186e47701fe7e47f74e625c36fdf3bd7747da68468b19
MD5 f94278449b410516f01b62b5650b71bd
BLAKE2b-256 a6a5403b7adbf9932861ff7f3b19f4f9b9b8ec0dceb1fcea0633046b7f5e9ced

See more details on using hashes here.

Provenance

The following attestation bundles were made for moto-5.1.16-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 Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page