.. image:: https://readthedocs.org/projects/simple-aws-rds/badge/?version=latest
:target: https://simple-aws-rds.readthedocs.io/index.html
:alt: Documentation Status
.. image:: https://github.com/MacHu-GWU/simple_aws_rds-project/workflows/CI/badge.svg
:target: https://github.com/MacHu-GWU/simple_aws_rds-project/actions?query=workflow:CI
.. image:: https://codecov.io/gh/MacHu-GWU/simple_aws_rds-project/branch/main/graph/badge.svg
:target: https://codecov.io/gh/MacHu-GWU/simple_aws_rds-project
.. image:: https://img.shields.io/pypi/v/simple_aws_rds.svg
:target: https://pypi.python.org/pypi/simple_aws_rds
.. image:: https://img.shields.io/pypi/l/simple_aws_rds.svg
:target: https://pypi.python.org/pypi/simple_aws_rds
.. image:: https://img.shields.io/pypi/pyversions/simple_aws_rds.svg
:target: https://pypi.python.org/pypi/simple_aws_rds
.. image:: https://img.shields.io/badge/Release_History!--None.svg?style=social
:target: https://github.com/MacHu-GWU/simple_aws_rds-project/blob/main/release-history.rst
.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social
:target: https://github.com/MacHu-GWU/simple_aws_rds-project
------
.. image:: https://img.shields.io/badge/Link-Document-blue.svg
:target: https://simple-aws-rds.readthedocs.io/en/latest/
.. image:: https://img.shields.io/badge/Link-API-blue.svg
:target: https://simple-aws-rds.readthedocs.io/en/latest/py-modindex.html
.. image:: https://img.shields.io/badge/Link-Source_Code-blue.svg
:target: https://simple-aws-rds.readthedocs.io/en/latest/py-modindex.html
.. image:: https://img.shields.io/badge/Link-Install-blue.svg
:target: `install`_
.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg
:target: https://github.com/MacHu-GWU/simple_aws_rds-project
.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg
:target: https://github.com/MacHu-GWU/simple_aws_rds-project/issues
.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg
:target: https://github.com/MacHu-GWU/simple_aws_rds-project/issues
.. image:: https://img.shields.io/badge/Link-Download-blue.svg
:target: https://pypi.org/pypi/simple_aws_rds#files
Welcome to ``simple_aws_rds`` Documentation
==============================================================================
.. image:: https://simple-aws-rds.readthedocs.io/en/latest/_static/simple_aws_rds-logo.png
:target: https://simple-aws-rds.readthedocs.io/en/latest/
Pythonic AWS RDS boto3 API, for human.
Usage:
.. code-block:: python
from simple_aws_rds.api import RDSDBInstance, RDSDBSnapshot
from boto_session_manager import BotoSesManager
bsm = BotoSesManager()
# get db instance by id
db_inst = RDSDBInstance.from_id(bsm, "my-db-identifier")
# get db instance by tag key value pair, it returns a iter proxy that may have multiple db instance
db_inst = RDSDBInstance.from_tag_key_value(bsm, key="Env", value="prod").one_or_none()
db_inst = RDSDBInstance.query(bsm, filters=..., db_instance_identifier=...).all()
print(db_inst.id)
print(db_inst.status)
print(db_inst.instance_class)
print(db_inst.instance_create_time)
print(db_inst.engine)
print(db_inst.engine_version)
print(db_inst.endpoint)
print(db_inst.port)
print(db_inst.hosted_zone_id)
print(db_inst.vpc_id)
print(db_inst.subnet_ids)
print(db_inst.security_groups)
print(db_inst.availability_zone)
print(db_inst.publicly_accessible)
print(db_inst.tags)
print(db_inst.data)
print(db_inst.is_available())
print(db_inst.is_stopped())
print(db_inst.is_ready_to_start())
print(db_inst.is_ready_to_stop())
.. _install:
Install
------------------------------------------------------------------------------
``simple_aws_rds`` is released on PyPI, so all you need is:
.. code-block:: console
$ pip install simple_aws_rds
To upgrade to latest version:
.. code-block:: console
$ pip install --upgrade simple_aws_rds
Raw data
{
"_id": null,
"home_page": "https://github.com/MacHu-GWU/simple_aws_rds-project",
"name": "simple-aws-rds",
"maintainer": "Unknown",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": null,
"author": "Sanhe Hu",
"author_email": "husanhe@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/26/20/58b40b6f2f92c4519bbfdec7c452b7eeb6713add66f81dbf76ea4f2e3e5d/simple_aws_rds-0.5.3.tar.gz",
"platform": "Windows",
"description": "\n.. image:: https://readthedocs.org/projects/simple-aws-rds/badge/?version=latest\n :target: https://simple-aws-rds.readthedocs.io/index.html\n :alt: Documentation Status\n\n.. image:: https://github.com/MacHu-GWU/simple_aws_rds-project/workflows/CI/badge.svg\n :target: https://github.com/MacHu-GWU/simple_aws_rds-project/actions?query=workflow:CI\n\n.. image:: https://codecov.io/gh/MacHu-GWU/simple_aws_rds-project/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/MacHu-GWU/simple_aws_rds-project\n\n.. image:: https://img.shields.io/pypi/v/simple_aws_rds.svg\n :target: https://pypi.python.org/pypi/simple_aws_rds\n\n.. image:: https://img.shields.io/pypi/l/simple_aws_rds.svg\n :target: https://pypi.python.org/pypi/simple_aws_rds\n\n.. image:: https://img.shields.io/pypi/pyversions/simple_aws_rds.svg\n :target: https://pypi.python.org/pypi/simple_aws_rds\n\n.. image:: https://img.shields.io/badge/Release_History!--None.svg?style=social\n :target: https://github.com/MacHu-GWU/simple_aws_rds-project/blob/main/release-history.rst\n\n.. image:: https://img.shields.io/badge/STAR_Me_on_GitHub!--None.svg?style=social\n :target: https://github.com/MacHu-GWU/simple_aws_rds-project\n\n------\n\n.. image:: https://img.shields.io/badge/Link-Document-blue.svg\n :target: https://simple-aws-rds.readthedocs.io/en/latest/\n\n.. image:: https://img.shields.io/badge/Link-API-blue.svg\n :target: https://simple-aws-rds.readthedocs.io/en/latest/py-modindex.html\n\n.. image:: https://img.shields.io/badge/Link-Source_Code-blue.svg\n :target: https://simple-aws-rds.readthedocs.io/en/latest/py-modindex.html\n\n.. image:: https://img.shields.io/badge/Link-Install-blue.svg\n :target: `install`_\n\n.. image:: https://img.shields.io/badge/Link-GitHub-blue.svg\n :target: https://github.com/MacHu-GWU/simple_aws_rds-project\n\n.. image:: https://img.shields.io/badge/Link-Submit_Issue-blue.svg\n :target: https://github.com/MacHu-GWU/simple_aws_rds-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Request_Feature-blue.svg\n :target: https://github.com/MacHu-GWU/simple_aws_rds-project/issues\n\n.. image:: https://img.shields.io/badge/Link-Download-blue.svg\n :target: https://pypi.org/pypi/simple_aws_rds#files\n\n\nWelcome to ``simple_aws_rds`` Documentation\n==============================================================================\n.. image:: https://simple-aws-rds.readthedocs.io/en/latest/_static/simple_aws_rds-logo.png\n :target: https://simple-aws-rds.readthedocs.io/en/latest/\n\nPythonic AWS RDS boto3 API, for human.\n\nUsage:\n\n.. code-block:: python\n\n from simple_aws_rds.api import RDSDBInstance, RDSDBSnapshot\n from boto_session_manager import BotoSesManager\n\n bsm = BotoSesManager()\n\n # get db instance by id\n db_inst = RDSDBInstance.from_id(bsm, \"my-db-identifier\")\n # get db instance by tag key value pair, it returns a iter proxy that may have multiple db instance\n db_inst = RDSDBInstance.from_tag_key_value(bsm, key=\"Env\", value=\"prod\").one_or_none()\n db_inst = RDSDBInstance.query(bsm, filters=..., db_instance_identifier=...).all()\n\n print(db_inst.id)\n print(db_inst.status)\n print(db_inst.instance_class)\n print(db_inst.instance_create_time)\n print(db_inst.engine)\n print(db_inst.engine_version)\n print(db_inst.endpoint)\n print(db_inst.port)\n print(db_inst.hosted_zone_id)\n print(db_inst.vpc_id)\n print(db_inst.subnet_ids)\n print(db_inst.security_groups)\n print(db_inst.availability_zone)\n print(db_inst.publicly_accessible)\n print(db_inst.tags)\n print(db_inst.data)\n\n print(db_inst.is_available())\n print(db_inst.is_stopped())\n print(db_inst.is_ready_to_start())\n print(db_inst.is_ready_to_stop())\n\n\n.. _install:\n\nInstall\n------------------------------------------------------------------------------\n\n``simple_aws_rds`` is released on PyPI, so all you need is:\n\n.. code-block:: console\n\n $ pip install simple_aws_rds\n\nTo upgrade to latest version:\n\n.. code-block:: console\n\n $ pip install --upgrade simple_aws_rds\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Pythonic AWS RDS boto3 API, for human.",
"version": "0.5.3",
"project_urls": {
"Download": "https://pypi.python.org/pypi/simple_aws_rds/0.5.3#downloads",
"Homepage": "https://github.com/MacHu-GWU/simple_aws_rds-project"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1768131f5796dde1eca50042af7151600780a537693fbc0ae4d926e17747f90b",
"md5": "660e85393df42c8debd24a667e9223ee",
"sha256": "fb2dc114342b2661b1c0ed2284220d638737e114b7dcdfd88e1a3f1ea444b7f1"
},
"downloads": -1,
"filename": "simple_aws_rds-0.5.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "660e85393df42c8debd24a667e9223ee",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 16839,
"upload_time": "2024-06-19T20:59:55",
"upload_time_iso_8601": "2024-06-19T20:59:55.305557Z",
"url": "https://files.pythonhosted.org/packages/17/68/131f5796dde1eca50042af7151600780a537693fbc0ae4d926e17747f90b/simple_aws_rds-0.5.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "262058b40b6f2f92c4519bbfdec7c452b7eeb6713add66f81dbf76ea4f2e3e5d",
"md5": "66286152d23105b30746311f2b146c2a",
"sha256": "fa08b5c19594b4a85c6edfae2cba81a1d34ed237540ef3cf9e5dce531983e7db"
},
"downloads": -1,
"filename": "simple_aws_rds-0.5.3.tar.gz",
"has_sig": false,
"md5_digest": "66286152d23105b30746311f2b146c2a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 19655,
"upload_time": "2024-06-19T20:59:57",
"upload_time_iso_8601": "2024-06-19T20:59:57.019621Z",
"url": "https://files.pythonhosted.org/packages/26/20/58b40b6f2f92c4519bbfdec7c452b7eeb6713add66f81dbf76ea4f2e3e5d/simple_aws_rds-0.5.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-19 20:59:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "MacHu-GWU",
"github_project": "simple_aws_rds-project",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [
{
"name": "func_args",
"specs": [
[
"<",
"2.0.0"
],
[
">=",
"0.1.1"
]
]
},
{
"name": "iterproxy",
"specs": [
[
"<",
"2.0.0"
],
[
">=",
"0.2.1"
]
]
}
],
"tox": true,
"lcname": "simple-aws-rds"
}
JSON
