Skip to main content

Python package for managing file upload/download via selected file system.

Project description

Assets Store

Github

This library was created to simplify the upload/download of files from/to S3, Azure Storage, or your desired server.

Setup instructions

The project is using python 3.12, it relies on boto3 lib for S3, azure-storage-blob for AzureStorage, and paramiko for server connections.

How to use

Install with pip depending on which type of storage do you use (s3,server,azure,minio are choices):

pip install AssetsStore[s3]

Set environment variables dependent on what upload you are using:

  • AzureStorage
ASSET_STORE=AzureFiles
ASSET_ACCESS_KEY="put_access_key"
ASSET_SECRET_ACCESS_KEY="put_access_key_secret"
ASSET_LOCATION="name_of_the_blob"
ASSET_PUBLIC_URL="blob_public_url"
LOCAL_STORE=path_to_download_folder
  • S3
ASSET_STORE=S3Files
ASSET_ACCESS_KEY="put_access_key"
ASSET_SECRET_ACCESS_KEY="put_access_key_secret"
ASSET_LOCATION="name_of_the_bucket"
ASSET_PUBLIC_URL="blob_public_url"
ASSET_REGION="s3_region"
LOCAL_STORE=path_to_download_folder
  • for local development
ASSET_STORE=LocalFiles
ASSET_LOCATION="path_to_folder"
ASSET_PUBLIC_URL="local_url_if_folder_hosted"
LOCAL_STORE=path_to_download_folder

The library has the ability to use Rebrand and to use it add these envs:

REBRAND_KEY="rebrand_key"
REBRAND_DOMAIN='rebrand_domain'

Usage example

from assetsstore.assets import FileAssets

assets = FileAssets.get_asset()  # setup asset store
assets.put_file("some_file.txt")  # Upload file from local download folder
assets.get_file("some_file.txt")  # Download file to local download folder
assets.del_local_file("some_file.txt")  # Delete file from local download folder
assets.del_file("some_file.txt")  # Deletes file from server

Authors

Deployment to PyPI

flit build
flit publish

Contributing

Contributions are always welcome! :)

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

assetsstore-1.1.0.tar.gz (19.0 kB view hashes)

Uploaded Source

Built Distribution

assetsstore-1.1.0-py2.py3-none-any.whl (24.1 kB view hashes)

Uploaded Python 2 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