cmq 0.0.1__tar.gz

cmq-0.0.1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

cmq-0.0.1/PKG-INFO

@@ -0,0 +1,194 @@
+Metadata-Version: 2.3
+Name: cmq
+Version: 0.0.1
+Summary: Cloud Multi Query is a library & CLI tool that allows you to run queries across multiple cloud accounts in parallel.
+Author: Daniel Isla Cruz
+Author-email: daniel.islacruz@ocado.com
+Requires-Python: >=3.10,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: atpbar (==2.0.4)
+Requires-Dist: boto3 (>=1.34.80,<2.0.0)
+Requires-Dist: click (>=8.1.7,<9.0.0)
+Requires-Dist: matplotlib (>=3.9.0,<4.0.0)
+Requires-Dist: python-benedict (>=0.33.2,<0.34.0)
+Requires-Dist: requests (>=2.31.0,<3.0.0)
+Requires-Dist: rich (>=13.7.1,<14.0.0)
+Description-Content-Type: text/markdown
+
+# Cloud Multi Query
+
+Cloud Multi Query is a Python library & CLI tool that allows you to run the same query across multiple cloud accounts in parallel, making it easy to gather insights and manage multi-account environments efficiently.
+
+So far, CMQ only supports AWS cloud accounts. However, the plugable structure of CMQ allows for the creation of new session and resource types to include other cloud providers.
+
+## Installation
+
+```
+pip install cmq
+```
+
+## Basic usage
+
+CMQ works using profiles defined in your local machine ([AWS CLI configuration](https://docs.aws.amazon.com/cli/v1/userguide/cli-configure-files.html)). It's expected that every profile defines the access to an account/region.
+
+Let's start listing the configured profiles:
+
+```bash
+cmq 'profile().list()'
+[
+   {
+    "name": "account_a",
+    "region": "us-east-1"
+  },
+  {
+    "name": "account_b",
+    "region": "eu-west-1"
+  }
+]
+```
+
+We can list resources for these accounts. CMQ will execute the queries in parallel. For example, lets list RDS resources:
+
+```bash
+cmq 'profile().rds().list()'
+[
+ {
+    "DBInstanceIdentifier": "account-a-users",
+    "DBInstanceClass": "db.m6g.large",
+    "Engine": "postgres",
+    ...
+ },
+ {
+    "DBInstanceIdentifier": "account-b-users",
+    "DBInstanceClass": "db.m6g.large",
+    "Engine": "postgres",
+    ...
+ },
+ ...
+]
+```
+
+We can also use `cmq` as a Python library. This is more convenient when you need to process the results:
+
+```python
+>>> from cmq.aws.session.profile import profile
+>>> profile().sqs().list()
+[
+ {"resource": "https://sqs.us-east-1.amazonaws.com/123456789012/account-a-products"},
+ {"resource": "https://sqs.us-east-1.amazonaws.com/123456789012/account-a-orders"},
+ {"resource": "https://sqs.eu-west-1.amazonaws.com/210987654321/account-b-products"},
+ {"resource": "https://sqs.eu-west-1.amazonaws.com/210987654321/account-b-orders"}
+]
+```
+
+## Enable verbose output
+
+We can export the environment variable `CMQ_VERBOSE_OUTPUT=true` or use the option `verbose` in the CLI to output the progress of the query. This is particular useful when you have many accounts to process:
+
+```bash
+cmq --verbose 'profile().elasticache().list()'
+ 100.00% :::::::::::::::::::::::::::::::::::::::: |        1 /        1 |:  account-dev     elasticache
+ 100.00% :::::::::::::::::::::::::::::::::::::::: |        1 /        1 |:  account-test    elasticache
+ 100.00% :::::::::::::::::::::::::::::::::::::::: |        1 /        1 |:  account-prd1    elasticache
+ 100.00% :::::::::::::::::::::::::::::::::::::::: |        1 /        1 |:  account-prd2    elasticache
+ 100.00% :::::::::::::::::::::::::::::::::::::::: |        1 /        1 |:  account-prd3    elasticache
+[
+    ... resource list ...
+]
+```
+
+## Examples
+
+While we work on the full documentation, we'll share some example queries to give you an idea of what you can do with the tool:
+
+List RDS resources in one profile with name `account_a`
+```bash
+cmq 'profile(name="account_a").rds().list()'
+```
+
+List SNS topics for all profiles, but returning a dictionary where the key is the name of the profile:
+```bash
+cmq 'profile().sns().dict()'
+{
+    "account_a": [
+        ... topics from account a ...
+    ],
+     "account_b": [
+        ... topics from account b ...
+    ],
+}
+```
+
+List all roles for all accounts, but return only the `RoleName` field:
+```bash
+cmq 'profile().role().attr("RoleName").list()'
+```
+
+List DynamoDB tables, but limit the results to 10 tables:
+```bash
+cmq 'profile().dynamodb().limit(10).list()'
+```
+
+CMQ uses `boto3` to list/describe resources. You can also use the parameters of the `boto3` functions to filter resources in the request. For example, this will list all SQS queues with prefix `order` in all accounts:
+
+```bash
+cmq 'profile().sqs(QueueNamePrefix="order").list()'
+```
+
+We can also filter resources in the response. CMQ is built with a set of quick filters that you can use with any resource type. All the filters have the same structure: `__filter__(key, value)`
+
+For example, the following query list Lambda functions running with `python3.10` in all accounts:
+
+```bash
+cmq 'profile().function().eq("Runtime", "python3.10").list()'
+```
+
+These are the supported quick filters:
+
+* eq
+* ne
+* in_
+* contains
+* not_contains
+* starts_with
+* ends_with
+* gt
+* lt
+
+## Supported resources
+
+AWS
+* address
+* alarm
+* cloudformation
+* cloudtrail
+* dynamodb
+* ec2
+* elasticache_parameter_group
+* elasticache_replication_group
+* elasticache_subnet_group
+* elasticache
+* function
+* kinesis
+* kms_alias
+* kms
+* log_event
+* log_stream
+* log
+* metric
+* rds_parameter_group
+* rds
+* resource_explorer
+* resource_group
+* role
+* s3_object
+* s3
+* sns
+* sqs
+* user_key
+* user
+

cmq-0.0.1/README.md

@@ -0,0 +1,172 @@
+# Cloud Multi Query
+
+Cloud Multi Query is a Python library & CLI tool that allows you to run the same query across multiple cloud accounts in parallel, making it easy to gather insights and manage multi-account environments efficiently.
+
+So far, CMQ only supports AWS cloud accounts. However, the plugable structure of CMQ allows for the creation of new session and resource types to include other cloud providers.
+
+## Installation
+
+```
+pip install cmq
+```
+
+## Basic usage
+
+CMQ works using profiles defined in your local machine ([AWS CLI configuration](https://docs.aws.amazon.com/cli/v1/userguide/cli-configure-files.html)). It's expected that every profile defines the access to an account/region.
+
+Let's start listing the configured profiles:
+
+```bash
+cmq 'profile().list()'
+[
+   {
+    "name": "account_a",
+    "region": "us-east-1"
+  },
+  {
+    "name": "account_b",
+    "region": "eu-west-1"
+  }
+]
+```
+
+We can list resources for these accounts. CMQ will execute the queries in parallel. For example, lets list RDS resources:
+
+```bash
+cmq 'profile().rds().list()'
+[
+ {
+    "DBInstanceIdentifier": "account-a-users",
+    "DBInstanceClass": "db.m6g.large",
+    "Engine": "postgres",
+    ...
+ },
+ {
+    "DBInstanceIdentifier": "account-b-users",
+    "DBInstanceClass": "db.m6g.large",
+    "Engine": "postgres",
+    ...
+ },
+ ...
+]
+```
+
+We can also use `cmq` as a Python library. This is more convenient when you need to process the results:
+
+```python
+>>> from cmq.aws.session.profile import profile
+>>> profile().sqs().list()
+[
+ {"resource": "https://sqs.us-east-1.amazonaws.com/123456789012/account-a-products"},
+ {"resource": "https://sqs.us-east-1.amazonaws.com/123456789012/account-a-orders"},
+ {"resource": "https://sqs.eu-west-1.amazonaws.com/210987654321/account-b-products"},
+ {"resource": "https://sqs.eu-west-1.amazonaws.com/210987654321/account-b-orders"}
+]
+```
+
+## Enable verbose output
+
+We can export the environment variable `CMQ_VERBOSE_OUTPUT=true` or use the option `verbose` in the CLI to output the progress of the query. This is particular useful when you have many accounts to process:
+
+```bash
+cmq --verbose 'profile().elasticache().list()'
+ 100.00% :::::::::::::::::::::::::::::::::::::::: |        1 /        1 |:  account-dev     elasticache
+ 100.00% :::::::::::::::::::::::::::::::::::::::: |        1 /        1 |:  account-test    elasticache
+ 100.00% :::::::::::::::::::::::::::::::::::::::: |        1 /        1 |:  account-prd1    elasticache
+ 100.00% :::::::::::::::::::::::::::::::::::::::: |        1 /        1 |:  account-prd2    elasticache
+ 100.00% :::::::::::::::::::::::::::::::::::::::: |        1 /        1 |:  account-prd3    elasticache
+[
+    ... resource list ...
+]
+```
+
+## Examples
+
+While we work on the full documentation, we'll share some example queries to give you an idea of what you can do with the tool:
+
+List RDS resources in one profile with name `account_a`
+```bash
+cmq 'profile(name="account_a").rds().list()'
+```
+
+List SNS topics for all profiles, but returning a dictionary where the key is the name of the profile:
+```bash
+cmq 'profile().sns().dict()'
+{
+    "account_a": [
+        ... topics from account a ...
+    ],
+     "account_b": [
+        ... topics from account b ...
+    ],
+}
+```
+
+List all roles for all accounts, but return only the `RoleName` field:
+```bash
+cmq 'profile().role().attr("RoleName").list()'
+```
+
+List DynamoDB tables, but limit the results to 10 tables:
+```bash
+cmq 'profile().dynamodb().limit(10).list()'
+```
+
+CMQ uses `boto3` to list/describe resources. You can also use the parameters of the `boto3` functions to filter resources in the request. For example, this will list all SQS queues with prefix `order` in all accounts:
+
+```bash
+cmq 'profile().sqs(QueueNamePrefix="order").list()'
+```
+
+We can also filter resources in the response. CMQ is built with a set of quick filters that you can use with any resource type. All the filters have the same structure: `__filter__(key, value)`
+
+For example, the following query list Lambda functions running with `python3.10` in all accounts:
+
+```bash
+cmq 'profile().function().eq("Runtime", "python3.10").list()'
+```
+
+These are the supported quick filters:
+
+* eq
+* ne
+* in_
+* contains
+* not_contains
+* starts_with
+* ends_with
+* gt
+* lt
+
+## Supported resources
+
+AWS
+* address
+* alarm
+* cloudformation
+* cloudtrail
+* dynamodb
+* ec2
+* elasticache_parameter_group
+* elasticache_replication_group
+* elasticache_subnet_group
+* elasticache
+* function
+* kinesis
+* kms_alias
+* kms
+* log_event
+* log_stream
+* log
+* metric
+* rds_parameter_group
+* rds
+* resource_explorer
+* resource_group
+* role
+* s3_object
+* s3
+* sns
+* sqs
+* user_key
+* user

cmq-0.0.1/pyproject.toml

@@ -0,0 +1,94 @@
+[project]
+name = "cmq"
+version = "0.0.1"
+description = "Cloud Multi Query is a library & CLI tool that allows you to run queries across multiple cloud accounts in parallel."
+authors = [
+    {name = "Daniel Isla Cruz", email= "daniel.islacruz@ocado.com"}
+]
+readme = "README.md"
+packages = [{include = "cmq", from = "src"}]
+
+[project.entry-points."cmq.provider.aws"]
+
+## Sessions
+profile = "cmq.aws.session.profile:profile"
+
+## Resources
+address                         = "cmq.aws.resource.address:address"
+alarm                           = "cmq.aws.resource.alarm:alarm"
+cloudformation                  = "cmq.aws.resource.cloudformation:cloudformation"
+cloudtrail                      = "cmq.aws.resource.cloudtrail:cloudtrail"
+dynamodb                        = "cmq.aws.resource.dynamodb:dynamodb"
+ec2                             = "cmq.aws.resource.ec2:ec2"
+elasticache_parameter_group     = "cmq.aws.resource.elasticache_parameter_group:elasticache_parameter_group"
+elasticache_replication_group   = "cmq.aws.resource.elasticache_replication_group:elasticache_replication_group"
+elasticache_subnet_group        = "cmq.aws.resource.elasticache_subnet_group:elasticache_subnet_group"
+elasticache                     = "cmq.aws.resource.elasticache:elasticache"
+function                        = "cmq.aws.resource.function:function"
+kinesis                         = "cmq.aws.resource.kinesis:kinesis"
+kms_alias                       = "cmq.aws.resource.kms_alias:kms_alias"
+kms                             = "cmq.aws.resource.kms:kms"
+log_event                       = "cmq.aws.resource.log_event:log_event"
+log_stream                      = "cmq.aws.resource.log_stream:log_stream"
+log                             = "cmq.aws.resource.log:log"
+metric                          = "cmq.aws.resource.metric:metric"
+rds_parameter_group             = "cmq.aws.resource.rds_parameter_group:rds_parameter_group"
+rds                             = "cmq.aws.resource.rds:rds"
+resource_explorer               = "cmq.aws.resource.resource_explorer:resource_explorer"
+resource_group                  = "cmq.aws.resource.resource_group:resource_group"
+role                            = "cmq.aws.resource.role:role"
+s3_object                       = "cmq.aws.resource.s3_object:s3_object"
+s3                              = "cmq.aws.resource.s3:s3"
+sns                             = "cmq.aws.resource.sns:sns"
+sqs                             = "cmq.aws.resource.sqs:sqs"
+user_key                        = "cmq.aws.resource.user_key:user_key"
+user                            = "cmq.aws.resource.user:user"
+
+[project.scripts]
+cmq = "cmq.cli:main"
+
+[tool.poetry.dependencies]
+python = "^3.10"
+requests = "^2.31.0"
+boto3 = "^1.34.80"
+rich = "^13.7.1"
+atpbar = "2.0.4"
+matplotlib = "^3.9.0"
+python-benedict = "^0.33.2"
+click = "^8.1.7"
+
+[tool.poetry.group.dev.dependencies]
+mypy = "^1.9.0"
+black = "^24.3.0"
+isort = "^5.13.2"
+pylama = "^8.4.1"
+mkdocs = "^1.6.0"
+ruff = "^0.4.4"
+pytest = "^8.2.1"
+moto = "^5.0.7"
+requests = "^2.32.1"
+setuptools = "^69.5.1"
+pytest-cov = "^5.0.0"
+mkdocstrings = {extras = ["python"], version = "^0.26.1"}
+mkdocs-material = "^9.5.27"
+mkdocs-video = "^1.5.0"
+mkdocs-autorefs = "^1.2.0"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-s -v --durations=0 --cov-report=term --cov-report=xml:coverage.xml --cov=cmq"
+
+[tool.coverage.run]
+branch = true
+source = ["cmq"]
+command_line = "-m pytest"
+
+[tool.coverage.report]
+show_missing = true
+
+[tool.coverage.xml]
+output = "coverage.xml"