S3Browser is a tool to help you browse your S3 Buckets like a local filesystem. It features `cd`, `ls`, and `pwd` for now, with some added bonuses around showing rollups for directory sizes and the most recently modified file. For now it is read only, though if you want any features feel free to suggest them.
### Installation
```
pip install s3browser
```
### Usage
You can pass access keys to `s3browser` directly, or just let it pick them up from your environment. It uses `boto` under the hood so you can use an existing configurations for that.
```
usage: s3browser [-h] [--access-key-id ACCESS_KEY_ID]
[--secret-access-key SECRET_ACCESS_KEY]
Run S3Browser
optional arguments:
-h, --help show this help message and exit
--access-key-id ACCESS_KEY_ID
AWS_ACCESS_KEY_ID used by Boto
--secret-access-key SECRET_ACCESS_KEY
AWS_SECRET_ACCESS_KEY used by Boto
```
Once you are in the CLI, it will automatically load a list of all of your available S3 buckets. You can use the `help` command to get detailed information for each of the commands.
### Gotchas
`s3browser` is written in Python, so it is not the most efficient. For really large buckets be prepared to wait a while for it to complete. S3 requires us to page through all the files to retrieve them, and currently that is done serially in chunks of 1000. Additionally, the internal representation of each S3 Key is ~800 Bytes, once you use `refresh` on a bucket with millions of keys, expect some memory pressure.
I have successfully browsed ~15mm keys on my dev machine with 16GB of RAM, of which python used ~12GB. If key retrieval speed or memory usage are big issues for you, feel free to open a ticket and we can spend the time to find better ways to implement the internal structures so they are more compact!
Metadata
Release files for s3browser 0.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| s3browser-0.0.1.tar.gz | 9.3 kB | Without provenance | Details |
Release files / s3browser-0.0.1.tar.gz
| Download URL | s3browser-0.0.1.tar.gz |
|---|---|
| Size | 9.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e7107ddc2186e56fba0ec2e0be22b8e9e0b5706c545d935268278a3a932e5c35
|
|
BLAKE2b-256 checksum How to use checksums |
706fa0d05abd762ae83bc00b1d50285f313e3348c6575ad7bdc63bea870fda05
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for s3browser 0.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.