# 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.
Raw data
{
"_id": null,
"home_page": "https://github.com/getmoto/moto",
"name": "moto",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "aws ec2 s3 boto3 mock",
"author": "Steve Pulec",
"author_email": "spulec@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/5b/4d/388c76475f81d9d588292b5eaada0fa1cdebebae2024d6bb8fdb9a03d08e/moto-5.0.5.tar.gz",
"platform": null,
"description": "# Moto - Mock AWS Services\n\n[](https://gitter.im/awsmoto/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\n\n[](https://github.com/getmoto/moto/actions)\n[](https://codecov.io/gh/getmoto/moto)\n[](http://docs.getmoto.org)\n[](https://pypi.org/project/moto/)\n[](#)\n[](https://pypistats.org/packages/moto)\n[](https://github.com/astral-sh/ruff)\n[](https://opencollective.com/moto)\n\n\n## Install\n\n```console\n$ pip install 'moto[ec2,s3,all]'\n```\n\n## In a nutshell\n\n\nMoto is a library that allows your tests to easily mock out AWS Services.\n\nImagine you have the following python code that you want to test:\n\n```python\nimport boto3\n\n\nclass MyModel:\n def __init__(self, name, value):\n self.name = name\n self.value = value\n\n def save(self):\n s3 = boto3.client(\"s3\", region_name=\"us-east-1\")\n s3.put_object(Bucket=\"mybucket\", Key=self.name, Body=self.value)\n```\n\nTake a minute to think how you would have tested that in the past.\n\nNow see how you could test it with Moto:\n\n```python\nimport boto3\nfrom moto import mock_aws\nfrom mymodule import MyModel\n\n\n@mock_aws\ndef test_my_model_save():\n conn = boto3.resource(\"s3\", region_name=\"us-east-1\")\n # We need to create the bucket since this is all in Moto's 'virtual' AWS account\n conn.create_bucket(Bucket=\"mybucket\")\n model_instance = MyModel(\"steve\", \"is awesome\")\n model_instance.save()\n body = conn.Object(\"mybucket\", \"steve\").get()[\"Body\"].read().decode(\"utf-8\")\n assert body == \"is awesome\"\n```\n\nWith 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.\n\nFor 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).\n\n\n### Documentation\nThe full documentation can be found here:\n\n[http://docs.getmoto.org/en/latest/](http://docs.getmoto.org/en/latest/)\n\n\n### Financial Contributions\nSupport this project and its continued development, by sponsoring us!\n\nClick the `Sponsor`-button at the top of the page for more information.\n\nOur finances are managed by OpenCollective, which means you have full visibility into all our contributions and expenses:\nhttps://opencollective.com/moto\n\n### Security contact information\n\nTo report a security vulnerability, please use the\n[Tidelift security contact](https://tidelift.com/security).\nTidelift will coordinate the fix and disclosure.\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": null,
"version": "5.0.5",
"project_urls": {
"Changelog": "https://github.com/getmoto/moto/blob/master/CHANGELOG.md",
"Documentation": "http://docs.getmoto.org/en/latest/",
"Homepage": "https://github.com/getmoto/moto",
"Issue tracker": "https://github.com/getmoto/moto/issues"
},
"split_keywords": [
"aws",
"ec2",
"s3",
"boto3",
"mock"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "905f1630167796932aaa807837f8c752988ff3b2c89646db34fbb158ddc06b99",
"md5": "5ee400e08662ca23809c0b66ebc345da",
"sha256": "4ecdd4084491a2f25f7a7925416dcf07eee0031ce724957439a32ef764b22874"
},
"downloads": -1,
"filename": "moto-5.0.5-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "5ee400e08662ca23809c0b66ebc345da",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 3641891,
"upload_time": "2024-04-06T19:17:30",
"upload_time_iso_8601": "2024-04-06T19:17:30.377939Z",
"url": "https://files.pythonhosted.org/packages/90/5f/1630167796932aaa807837f8c752988ff3b2c89646db34fbb158ddc06b99/moto-5.0.5-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5b4d388c76475f81d9d588292b5eaada0fa1cdebebae2024d6bb8fdb9a03d08e",
"md5": "222fc0078d9fd19f85e117c4bc637a56",
"sha256": "2eaca2df7758f6868df420bf0725cd0b93d98709606f1fb8b2343b5bdc822d91"
},
"downloads": -1,
"filename": "moto-5.0.5.tar.gz",
"has_sig": false,
"md5_digest": "222fc0078d9fd19f85e117c4bc637a56",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 5188450,
"upload_time": "2024-04-06T19:17:40",
"upload_time_iso_8601": "2024-04-06T19:17:40.189177Z",
"url": "https://files.pythonhosted.org/packages/5b/4d/388c76475f81d9d588292b5eaada0fa1cdebebae2024d6bb8fdb9a03d08e/moto-5.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-06 19:17:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "getmoto",
"github_project": "moto",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "moto"
}
JSON
