Skip to main content

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

klingon_file_manager-0.0.29.tar.gz (7.7 kB view hashes)

Uploaded Source

Built Distribution

klingon_file_manager-0.0.29-py3-none-any.whl (8.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page