Metadata-Version: 2.1
Name: asu-cli
Version: 0.0.2
Summary: aws s3 utils
Home-page: https://github.com/tekumara/asu
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: boto3 (==1.17.44)
Requires-Dist: typer (==0.3.2)
Requires-Dist: rich (==10.0.1)
Provides-Extra: dev
Requires-Dist: autopep8 (==1.5.6) ; extra == 'dev'
Requires-Dist: boto3-stubs[s3] (==1.17.44.0) ; extra == 'dev'
Requires-Dist: importlib-metadata (==3.10.0) ; extra == 'dev'
Requires-Dist: isort (==5.8.0) ; extra == 'dev'
Requires-Dist: flake8 (==3.9.0) ; extra == 'dev'
Requires-Dist: flake8-annotations (==2.6.1) ; extra == 'dev'
Requires-Dist: flake8-colors (==0.1.9) ; extra == 'dev'
Requires-Dist: pre-commit (==2.11.1) ; extra == 'dev'
Requires-Dist: pytest (==6.2.2) ; extra == 'dev'
Requires-Dist: twine (==3.4.1) ; extra == 'dev'

# AWS S3 CLI utils (asu)

[![Test](https://github.com/tekumara/asu/actions/workflows/pythonapp.yml/badge.svg)](https://github.com/tekumara/asu/actions/workflows/pythonapp.yml)
[![PyPI version](https://badge.fury.io/py/asu-cli.svg)](https://pypi.org/project/asu-cli/)

## Usage

```
Usage: asu [OPTIONS] COMMAND [ARGS]...

  AWS S3 CLI utils

Options:
  --install-completion [bash|zsh|fish|powershell|pwsh]
                                  Install completion for the specified shell.
  --show-completion [bash|zsh|fish|powershell|pwsh]
                                  Show completion for the specified shell, to
                                  copy it or customize the installation.

  --help                          Show this message and exit.

Commands:
  sse   List default encryption for all buckets
  tags  List tag for all buckets
```

## Install

Install the latest version using [pipx](https://github.com/pipxproject/pipx):

```
pipx install asu-cli
```

If you have previously installed asu, run `pipx upgrade asu-cli` to upgrade to the latest version.

## Development

### Prerequisites

- make
- node (required for pyright. Install via `brew install node`)
- python >= 3.7

### Getting started

To get started run `make install`. This will:

- install git hooks for formatting & linting on git push
- create the virtualenv in _./venv/_
- install this package in editable mode

Then run `make` to see the options for running checks, tests etc.

`. venv/bin/activate` activates the virtualenv. When the requirements in `setup.py` change, the virtualenv is updated by the make targets that use the virtualenv.


