Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spulec/moto
A library that allows you to easily mock out tests based on AWS infrastructure.
https://github.com/spulec/moto
aws boto ec2 s3
Last synced: 2 days ago
JSON representation
A library that allows you to easily mock out tests based on AWS infrastructure.
- Host: GitHub
- URL: https://github.com/spulec/moto
- Owner: getmoto
- License: apache-2.0
- Created: 2013-02-18T21:10:59.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T08:20:26.000Z (7 days ago)
- Last Synced: 2024-10-29T09:30:23.529Z (7 days ago)
- Topics: aws, boto, ec2, s3
- Language: Python
- Homepage: http://docs.getmoto.org/en/latest/
- Size: 44.7 MB
- Stars: 7,640
- Watchers: 66
- Forks: 2,045
- Open Issues: 36
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Authors: AUTHORS.md
Awesome Lists containing this project
- awesome-list - moto
- awesome-python-testing - moto - allows you to easily mock out tests based on AWS infrastructure. (Mock and Stub)
- starred-awesome - moto - Moto is a library that allows your python tests to easily mock out the boto library (Python)
README
# Moto - Mock AWS Services
[](https://gitter.im/awsmoto/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://github.com/getmoto/moto/actions)
[](https://codecov.io/gh/getmoto/moto)
[](http://docs.getmoto.org)
[](https://pypi.org/project/moto/)
[](#)
[](https://pypistats.org/packages/moto)
[](https://github.com/astral-sh/ruff)
[](https://opencollective.com/moto)
## Install
```console
$ 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:
```python
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:
```python
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](https://github.com/getmoto/moto/blob/master/IMPLEMENTATION_COVERAGE.md).
### Documentation
The full documentation can be found here:
[http://docs.getmoto.org/en/latest/](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](https://tidelift.com/security).
Tidelift will coordinate the fix and disclosure.