A Python module for managing files on both local and AWS S3 storage.
Project description
Klingon File Manager
Introduction
The Klingon File Manager is a Python module designed for managing files both locally and on AWS S3 storage. It provides functionalities to 'get' and 'post' files using a unified interface.
Installation
Run the following command to install the package:
pip install klingon_file_manager
Features
- Supports both local and AWS S3 storage
- Single function interface (
manage_file
) to handle 'get' and 'post' operations - Debugging support
Usage Examples
Using manage_file
function
Here's a basic example to get you started:
from klingon_file_manager import manage_file
# To get a file from a local storage
result = manage_file(action='get', path='path/to/local/file.txt')
# To post a file to a local storage
result = manage_file(action='post', path='path/to/local/file.txt', content='Your content here')
# To get a file from AWS S3
result = manage_file(action='get', path='s3://your-bucket/your-key')
# To post a file to AWS S3
result = manage_file(action='post', path='s3://your-bucket/your-key', content='Your content here')
Contribution Guidelines
If you wish to contribute to this project, please submit a pull request.
Running Tests
To run tests, execute the following command:
pytest
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for klingon_file_manager-0.0.29.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7525a70065336b8e7ca37ef0928a215b00af42170f7cbd680f2b3eef26cf3006 |
|
MD5 | 0d319661a54f2bba0b5cd07a6ed4c35b |
|
BLAKE2b-256 | a4d523a65ba0a94e9d440511f1d419f00c456cadf032a0be71a917e056394fe3 |
Close
Hashes for klingon_file_manager-0.0.29-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 05592ff3bdb8690661d16d56ac510d70efb9b449e8483fbdb5c693ddb13e665f |
|
MD5 | 78366f0de41b6cf748f4efe29311a603 |
|
BLAKE2b-256 | 18af1a9de42ff5cc7a522f4d589a1a44fd5de039ad45a63c8418730ef64319ba |