Skip to content

Commit

Permalink
publish to pypi
Browse files Browse the repository at this point in the history
  • Loading branch information
benbridts committed Jan 6, 2021
1 parent 9125122 commit 5c76966
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,11 @@ Additionally, you will need a role that you can assume with (one of) these permi
you're examining

## Installation
Until this is published to pypi, you will need to use `poetry` to install this.

1. Clone this repository
2. Run `poetry install`
3. Activate the virtualenvironment with `poetry shell` (you can also use `poetry run $command`)
This package is available on pypi, you can for example use on of these commands (pipx is recommended)
```shell
pipx install s3-account-search
pip install s3-account-search
```

## Usage Examples
```shell
Expand Down Expand Up @@ -44,7 +44,14 @@ discovering it one digit at a time.
incrementing until our request is allowed, and we find the first digit
3. We repeat this process for every digit. Using the already discovered digits as a prefix. E.g. if
the first digit was `8`, we test account ids starting with `80`, `81`, `82`, etc.


## Development
We use poetry to manage this project

1. Clone this repository
2. Run `poetry install`
3. Activate the virtualenvironment with `poetry shell` (you can also use `poetry run $command`)


## Possible improvements
- Instead of checking one digit at a time, we could use a binary search-like algorithm. Eg. the
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "s3-account-search"
version = "0.1.0"
version = "0.1.1"
description = "Search for the AWS Account that contains an S3 bucket or object"
authors = ["Ben Bridts"]

Expand Down

0 comments on commit 5c76966

Please sign in to comment.