| Name | cloud-cartographer JSON |
| Version |
0.0.3
JSON |
| download |
| home_page | None |
| Summary | AWS Cloudformation mapping tool to expose resources managed by Cloudformation and dependencies between stacks via their export/import relations. |
| upload_time | 2025-02-04 07:38:25 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | Copyright (c) 2025 vvgIT
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
of the Software, and to permit persons to whom the Software is furnished to do
so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
|
| keywords |
aws
cloud
graph
data visualization
dataviz
mapping
dependency
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Cloud Cartographer
Cloud Cartographer is a powerful tool for analyzing and visualizing AWS CloudFormation stacks. It provides capabilities to scan your AWS infrastructure, filter stacks by tags, and generate both tabular (markdown) and interactive visualizations of your cloud architecture.
## Features
- **Stack Discovery**: Scan AWS CloudFormation stacks across multiple regions
- **Tag-based Filtering**: Filter stacks based on specific tags
- **Flexible Output**: Generate markdown tables with customizable headers
- **Interactive Visualization**: Create interactive D3.js-based visualizations of stack relationships
- **Import/Export Mapping**: Visualize dependencies between stacks through their import/export relations
- **Multi-region Support**: Analyze stacks across multiple AWS regions
## Installation
### Prerequisites
- Python 3.x
- AWS credentials configured
- Git
### Steps
1. Clone the repository:
```bash
git clone https://github.com/vvangestel/cloud-cartographer.git
cd cloud-cartographer
```
2. Install the package:
```bash
pip3 install .
```
Note: PyPI installation will be available in future releases.
## Usage
### Basic Usage
The basic command structure is:
```bash
ccarto [-h] [-p PROFILE] [-r REGIONS [REGIONS ...]] [-f FILTER [FILTER ...]] [--headers HEADERS] [-i INPUT]
[-o OUTPUT] [-v]
```
### Command Line Options
- `-p, --profile PROFILE`: Specify the AWS profile to use
- `-r, --regions REGIONS [REGIONS ...]`: Specify one or more AWS regions to scan
- `-f, --filter FILTER [FILTER ...]`: Filter stacks by tags (format: Key:Value)
- `--headers HEADERS`: Custom headers for markdown table output
- `-i, --input INPUT`: Skip AWS API calls and use existing JSON data for visualization
- `-o, --output OUTPUT`: Specify output filename for JSON graph data (defaults to `cloudformation_map.json`)
- `-t, --title TITLE`: Specify title of generated markdown document (defaults to `Cloud Cartographer Table`)
- `-v, --verbose`: Enable verbose output
### Examples
1. Scan all stacks in a specific region:
```bash
ccarto -r eu-west-1
```
2. Filter stacks by tags:
```bash
ccarto -f Environment:Production Team:DevOps
```
3. Use a specific AWS profile and output to a specific file:
```bash
ccarto -p myprofile -o specific_output.json
```
4. Generate visualization from existing JSON: (TODO)
```bash
ccarto -i existing_data.json
```
## Visualization
The tool includes a D3.js-based visualization component that creates an interactive map of your CloudFormation stacks. To use the visualization:
1. Generate the JSON output using the tool
2. Open the included HTML file in a web browser
3. Explore the interactive visualization of your stack relationships
## Contributing
This is a WIP project. Contributions are welcome! Please feel free to submit a Pull Request.
## Support
For bugs and feature requests, please create an issue in the GitHub repository.
## Roadmap
- [ ] PyPI package publication
- [ ] Enhanced filtering capabilities
- [ ] Enhanced visualization options
Raw data
{
"_id": null,
"home_page": null,
"name": "cloud-cartographer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Vincent Van Gestel <vincent@vvgit.be>",
"keywords": "aws, cloud, graph, data visualization, dataviz, mapping, dependency",
"author": null,
"author_email": "Vincent Van Gestel <vincent@vvgit.be>",
"download_url": "https://files.pythonhosted.org/packages/9a/3f/2fb2f381d1eab754135703d077a022fdd0809295ae2e1a2ccdc8f972b3ff/cloud_cartographer-0.0.3.tar.gz",
"platform": null,
"description": "# Cloud Cartographer\n\nCloud Cartographer is a powerful tool for analyzing and visualizing AWS CloudFormation stacks. It provides capabilities to scan your AWS infrastructure, filter stacks by tags, and generate both tabular (markdown) and interactive visualizations of your cloud architecture.\n\n## Features\n\n- **Stack Discovery**: Scan AWS CloudFormation stacks across multiple regions\n- **Tag-based Filtering**: Filter stacks based on specific tags\n- **Flexible Output**: Generate markdown tables with customizable headers\n- **Interactive Visualization**: Create interactive D3.js-based visualizations of stack relationships\n- **Import/Export Mapping**: Visualize dependencies between stacks through their import/export relations\n- **Multi-region Support**: Analyze stacks across multiple AWS regions\n\n## Installation\n\n### Prerequisites\n\n- Python 3.x\n- AWS credentials configured\n- Git\n\n### Steps\n\n1. Clone the repository:\n```bash\ngit clone https://github.com/vvangestel/cloud-cartographer.git\ncd cloud-cartographer\n```\n\n2. Install the package:\n```bash\npip3 install .\n```\n\nNote: PyPI installation will be available in future releases.\n\n## Usage\n\n### Basic Usage\n\nThe basic command structure is:\n```bash\nccarto [-h] [-p PROFILE] [-r REGIONS [REGIONS ...]] [-f FILTER [FILTER ...]] [--headers HEADERS] [-i INPUT]\n [-o OUTPUT] [-v]\n```\n\n### Command Line Options\n\n- `-p, --profile PROFILE`: Specify the AWS profile to use\n- `-r, --regions REGIONS [REGIONS ...]`: Specify one or more AWS regions to scan\n- `-f, --filter FILTER [FILTER ...]`: Filter stacks by tags (format: Key:Value)\n- `--headers HEADERS`: Custom headers for markdown table output\n- `-i, --input INPUT`: Skip AWS API calls and use existing JSON data for visualization\n- `-o, --output OUTPUT`: Specify output filename for JSON graph data (defaults to `cloudformation_map.json`)\n- `-t, --title TITLE`: Specify title of generated markdown document (defaults to `Cloud Cartographer Table`)\n- `-v, --verbose`: Enable verbose output\n\n### Examples\n\n1. Scan all stacks in a specific region:\n```bash\nccarto -r eu-west-1\n```\n\n2. Filter stacks by tags:\n```bash\nccarto -f Environment:Production Team:DevOps\n```\n\n3. Use a specific AWS profile and output to a specific file:\n```bash\nccarto -p myprofile -o specific_output.json\n```\n\n4. Generate visualization from existing JSON: (TODO)\n```bash\nccarto -i existing_data.json\n```\n\n## Visualization\n\nThe tool includes a D3.js-based visualization component that creates an interactive map of your CloudFormation stacks. To use the visualization:\n\n1. Generate the JSON output using the tool\n2. Open the included HTML file in a web browser\n3. Explore the interactive visualization of your stack relationships\n\n## Contributing\n\nThis is a WIP project. Contributions are welcome! Please feel free to submit a Pull Request.\n\n## Support\n\nFor bugs and feature requests, please create an issue in the GitHub repository.\n\n## Roadmap\n\n- [ ] PyPI package publication\n- [ ] Enhanced filtering capabilities\n- [ ] Enhanced visualization options\n",
"bugtrack_url": null,
"license": "Copyright (c) 2025 vvgIT\n \n Permission is hereby granted, free of charge, to any person obtaining a copy of\n this software and associated documentation files (the \"Software\"), to deal in\n the Software without restriction, including without limitation the rights to\n use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies\n of the Software, and to permit persons to whom the Software is furnished to do\n so, subject to the following conditions:\n \n The above copyright notice and this permission notice shall be included in all\n copies or substantial portions of the Software.\n \n THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\n AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\n OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\n SOFTWARE.\n ",
"summary": "AWS Cloudformation mapping tool to expose resources managed by Cloudformation and dependencies between stacks via their export/import relations.",
"version": "0.0.3",
"project_urls": {
"Bug Reports": "https://github.com/vvangestel/cloud-cartographer/issues",
"Homepage": "https://github.com/vvangestel/cloud-cartographer",
"Source": "https://github.com/vvangestel/cloud-cartographer"
},
"split_keywords": [
"aws",
" cloud",
" graph",
" data visualization",
" dataviz",
" mapping",
" dependency"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d278a6edda4c64aa2f045afc0c389d09526cc42e2c5ffd7f9b8894cc9d2272bb",
"md5": "fc9d7ef7e8a70b0fa9a7274b8e84242f",
"sha256": "1adf39a65894db6d94ea79ec3a5c55fc1a1f0f17d8dcfc1145ee23ef4be5aa1f"
},
"downloads": -1,
"filename": "cloud_cartographer-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fc9d7ef7e8a70b0fa9a7274b8e84242f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 8261,
"upload_time": "2025-02-04T07:38:23",
"upload_time_iso_8601": "2025-02-04T07:38:23.764084Z",
"url": "https://files.pythonhosted.org/packages/d2/78/a6edda4c64aa2f045afc0c389d09526cc42e2c5ffd7f9b8894cc9d2272bb/cloud_cartographer-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "9a3f2fb2f381d1eab754135703d077a022fdd0809295ae2e1a2ccdc8f972b3ff",
"md5": "491371cbcf109b29c6c1fee080c1f40e",
"sha256": "3a9800441f9f9e3a8772d88052dc162b0501ab829c9c7a04d8ab35afb421c638"
},
"downloads": -1,
"filename": "cloud_cartographer-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "491371cbcf109b29c6c1fee080c1f40e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 9179,
"upload_time": "2025-02-04T07:38:25",
"upload_time_iso_8601": "2025-02-04T07:38:25.885604Z",
"url": "https://files.pythonhosted.org/packages/9a/3f/2fb2f381d1eab754135703d077a022fdd0809295ae2e1a2ccdc8f972b3ff/cloud_cartographer-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-04 07:38:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "vvangestel",
"github_project": "cloud-cartographer",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "cloud-cartographer"
}
