Skip to content

Commit

Permalink
Merge pull request #26 from cooperwalbrun/documentation
Browse files Browse the repository at this point in the history
Update the Project Overview and Python Usage Examples
  • Loading branch information
cooperwalbrun committed Jan 18, 2024
2 parents 324f1ba + 10e4c00 commit 2e3a5cc
Showing 1 changed file with 7 additions and 9 deletions.
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,10 @@

## Overview

`aws-cidr-finder` is a Python CLI tool which finds unused CIDR blocks (supports both IPv4 and IPv6)
in your AWS VPCs and outputs them to STDOUT. It is very simple, but can be quite useful for users
`aws-cidr-finder` is a Python CLI tool and library that finds unused CIDR blocks (either IPv4 or
IPv6) in AWS VPCs and outputs them to STDOUT. It is very simple but can be quite useful for users
who manage many subnets across one or more VPCs.

Use `aws-cidr-finder -h` to see command options.

### An Example

It is easiest to see the value of this tool through an example. Imagine that we have the following
Expand Down Expand Up @@ -188,12 +186,12 @@ for message in output["messages"]:
print(message)

for vpc in output["data"]:
# The following shows how to access all available fields in the data object
print(vpc["id"])
print(vpc["name"])
print(vpc["cidr"])
# Print all the information that is available in the VPC dict
print(f'VPC ID: {vpc["id"]}')
print(f'VPC Name: {vpc["name"]}')
print(f'VPC CIDR: {vpc["cidr"]}')
for cidr in vpc["available_cidr_blocks"]:
print(cidr)
print(f"Available CIDR block: {cidr}")
```

## Contributing
Expand Down

0 comments on commit 2e3a5cc

Please sign in to comment.