Metadata-Version: 2.1
Name: mgmt
Version: 0.7.0
Summary: 
Home-page: https://github.com/will-wright-eng/media-mgmt-cli
License: GNU GPL v3.0
Author: Will Wright
Author-email: willwright@example.com
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: boto3 (>=1.26.54,<2.0.0)
Requires-Dist: botocore (>=1.29.54,<2.0.0)
Requires-Dist: certifi (>=2022.12.7,<2024.0.0)
Requires-Dist: click (>=8.1.3,<9.0.0)
Requires-Dist: jmespath (>=1.0.1,<2.0.0)
Requires-Dist: pytest (>=7.2.1,<8.0.0)
Requires-Dist: python-dateutil (>=2.8.2,<3.0.0)
Requires-Dist: python-dotenv (>=1.0.0,<2.0.0)
Requires-Dist: rarfile (>=4.0,<5.0)
Requires-Dist: rich (>=13.3.5,<14.0.0)
Requires-Dist: s3transfer (>=0.6.0,<0.7.0)
Requires-Dist: six (>=1.16.0,<2.0.0)
Requires-Dist: typer (>=0.9.0,<0.10.0)
Requires-Dist: urllib3 (>=1.26.14,<2.0.0)
Project-URL: Repository, https://github.com/will-wright-eng/media-mgmt-cli
Description-Content-Type: text/markdown

# Media Management Command Line Interface

[![PyPI](https://img.shields.io/pypi/v/mgmt)](https://pypi.org/project/mgmt/)
[![Downloads](https://static.pepy.tech/badge/mgmt/month)](https://pepy.tech/project/mgmt)
[![Supported Versions](https://img.shields.io/badge/python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11-blue)](https://pypi.org/project/mgmt/)
[![Contributors](https://img.shields.io/github/contributors/will-wright-eng/media-mgmt-cli.svg)](https://github.com/will-wright-eng/media-mgmt-cli/graphs/contributors)
[![Tests](https://github.com/will-wright-eng/media-mgmt-cli/workflows/Test/badge.svg)](https://github.com/will-wright-eng/media-mgmt-cli/actions?query=workflow%3ATest)
[![Codeball](https://github.com/will-wright-eng/media-mgmt-cli/actions/workflows/codeball.yml/badge.svg)](https://github.com/will-wright-eng/media-mgmt-cli/actions/workflows/codeball.yml)


## Summary

**An intuitive command line interface that wraps boto3 to search and manage media assets**

## Installing `mgmt` & Supported Versions

`mgmt` is available on PyPI:

```bash
python -m pip install mgmt
```

Media Management Command Line Interface officially supports Python 3.8+.

## Supported Features & Usage

For help, run:

```bash
mgmt --help
```

Commands:

```bash
➜  media-mgmt-cli git:(cleanup6) mgmt --help                                                                 22:02:55

 Usage: mgmt [OPTIONS] COMMAND [ARGS]...

╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                                                                        │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ config         Configures the application                                                                          │
│ delete         Deletes the specified file from S3; requires confirmation                                           │
│ download       Downloads the specified file from S3                                                                │
│ ls             Lists the files in the specified location                                                           │
│ search         Searches for files that contain the specified keyword in their names                                │
│ status         Retrieves and prints the metadata of the specified file                                             │
│ upload         Uploads the specified file to S3                                                                    │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

```

Why not use `awscli`?

You can, and I do, in tandem with `mgmt` -- the purpose is to create an additional interface that minimized the lookup/copy/paste process I found myself frequently going through

## Development

To contribute to this tool, first checkout the code:

```bash
git clone https://github.com/will-wright-eng/media-mgmt-cli.git
cd media-mgmt-cli
```

Then create a new virtual environment:

```bash
python -m venv venv
source venv/bin/activate
```

Now install the dependencies and test dependencies:

```bash
pip install -e '.[test]'
```

To run the tests:

```bash
pytest
```

Install pre-commit before submitting a PR:

```bash
brew install pre-commit
pre-commit install
```

## References

- [PyPI Package](https://pypi.org/project/mgmt)
- Based on cookiecutter template [will-wright-eng/click-app](https://github.com/will-wright-eng/click-app)
- Rewrite of original project [will-wright-eng/media_mgmt_cli](https://github.com/will-wright-eng/media_mgmt_cli)

