Skip to content

A simple CLI to search and manage media assets in S3 and locally

License

Notifications You must be signed in to change notification settings

will-wright-eng/media-mgmt-cli

Repository files navigation

Media Management Command Line Interface

PyPI Downloads Supported Versions Contributors Tests Codeball

Summary

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

Installing mgmt & Supported Versions

mgmt is available on PyPI:

python -m pip install mgmt

Media Management Command Line Interface officially supports Python 3.8+.

Quick Start

  • setup global config file ~/.config/mgmt/config
mgmt config

fill out prompts

mgmt config

check configs are correct

mgmt ls

Supported Features & Usage

For help, run:

mgmt --help

Commands:

➜ mgmt --help

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

╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --version          Show the version and exit.                                                                   │
│ --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:

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

Then create a new virtual environment:

python -m venv venv
source venv/bin/activate

Now install the dependencies and test dependencies:

pip install -e '.[test]'

To run the tests:

pytest

Install pre-commit before submitting a PR:

brew install pre-commit
pre-commit install

References

About

A simple CLI to search and manage media assets in S3 and locally

Resources

License

Stars

Watchers

Forks

Packages

No packages published