Metadata-Version: 2.1
Name: balcony
Version: 0.1.0
Summary: AWS API for humans
License: GPL-3.0-or-later
Author: Oguzhan Yilmaz
Author-email: oguzhanylmz271@gmail.com
Requires-Python: >=3.7,<4.0
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Dist: PyYAML (>=6.0,<7.0)
Requires-Dist: boto3 (>=1.24.80,<2.0.0)
Requires-Dist: inflect (>=6.0.0,<7.0.0)
Requires-Dist: jmespath (>=1.0.1,<2.0.0)
Requires-Dist: mkdocs-autorefs (>=0.4.1,<0.5.0)
Requires-Dist: mkdocs-material (>=8.5.7,<10.0.0)
Requires-Dist: mkdocstrings[python] (>=0.21.2,<0.22.0)
Requires-Dist: pydantic (>=1.10.7,<2.0.0)
Requires-Dist: rich (>=13.3.4,<14.0.0)
Requires-Dist: typer (>=0.7.0,<0.8.0)
Description-Content-Type: text/markdown

# balcony


<div style="display: flex;">
  <a href="https://github.com/oguzhan-yilmaz/balcony/actions/workflows/docker-publish.yml"><img src="https://github.com/oguzhan-yilmaz/balcony/actions/workflows/docker-publish.yml/badge.svg" alt="Build and publish a Docker image to ghcr.io"></a>
  <span style="width: 5px"></span>

<a href="https://github.com/oguzhan-yilmaz/balcony/actions/workflows/pages/pages-build-deployment"><img src="https://github.com/oguzhan-yilmaz/balcony/actions/workflows/pages/pages-build-deployment/badge.svg" alt="Build and Deploy Documentation website"></a>
</div>



balcony dynamically parses AWS SDK(`boto3` library) and analyzes required parameters for each operation. 

By **establishing relations between operations over required parameters**, it's **able to auto-fill** them by reading the related operation beforehand.

By simply entering their name, balcony enables developers to easily list their AWS resources.


## Installation & Documentation 

**[https://oguzhan-yilmaz.github.io/balcony/](https://oguzhan-yilmaz.github.io/balcony/quickstart)**

Balcony's documentation website contains quickstart guide, usage cookbook and more.
## Features & GIFs
> click to play the videos
### List available AWS Services 
`balcony aws` to see every AWS service available.

![](https://github.com/oguzhan-yilmaz/balcony/blob/main/docs/visuals/aws-services-list.gif)


### List Resource Nodes of an AWS Service 
`balcony aws <service-name>` to see every Resource Node of a service.

![](https://github.com/oguzhan-yilmaz/balcony/blob/main/docs/visuals/resource-node-list.gif)


### Reading a Resource Node 
`balcony aws <service-name> <resource-node>` to read operations of a Resource Node.

![](https://github.com/oguzhan-yilmaz/balcony/blob/main/docs/visuals/reading-a-resource-node.gif)


### Documentation and Input & Output of Operations
Use the `--list`, `-l` flag to print the given AWS API Operations documentation, input & output structure. 
 

![](https://github.com/oguzhan-yilmaz/balcony/blob/main/docs/visuals/list-option.gif)


### Enable Debug messages 
Use the `--debug`, `-d` flag to see what's going on under the hood!

![](https://github.com/oguzhan-yilmaz/balcony/blob/main/docs/visuals/debug-messages.gif)

