https://github.com/merixstudio/simple-storage

File storage made easy
https://github.com/merixstudio/simple-storage

aws aws-s3 file filesystem python s3 storage

Last synced: 5 months ago
JSON representation

File storage made easy

• Host: GitHub
• URL: https://github.com/merixstudio/simple-storage
• Owner: merixstudio
• License: mit
• Created: 2021-09-08T19:21:13.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2022-02-23T10:25:11.000Z (over 4 years ago)
• Last Synced: 2025-09-22T14:32:50.601Z (9 months ago)
• Topics: aws, aws-s3, file, filesystem, python, s3, storage
• Language: Python
• Homepage: https://pypi.org/project/simple-storage/
• Size: 70.3 KB
• Stars: 6
• Watchers: 3
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Simple Storage

Data storage made simple.

[![codecov](https://codecov.io/gh/merixstudio/simple-storage/branch/master/graph/badge.svg?token=XMH3S6M34G)](https://codecov.io/gh/merixstudio/simple-storage)

![python](https://img.shields.io/badge/Python-3.6%2B-brightgreen)

[![PyPI Version](https://img.shields.io/pypi/v/simple-storage.svg)](https://pypi.org/project/simple-storage/)

## Supported storages

- File system

- AWS S3

- Google Cloud Storage

## Requirements

- Python >= 3.6

# How to use

Install the package:

```shell

pip install simple-storage

```

Now, depending on the storage you want to use, follow the instructions below.

## File system storage

| Environment variable | Value                                                               |

|----------------------|---------------------------------------------------------------------|

| `STORAGES_BACKEND`   | `storages.backends.file_system.FileSystemStorage`                   |

| `STORAGES_PATH`      | Point to the existing path in your file system, e.g.  `/app/media`. |

## AWS S3 storage

| Environment variable             | Value                                         |

|----------------------------------|-----------------------------------------------|

| `STORAGES_BACKEND`               | `storages.backends.amazon_s3.AmazonS3Storage` |

| `STORAGES_AWS_ACCESS_KEY_ID`     | Your AWS access key ID.                       |

| `STORAGES_AWS_SECRET_ACCESS_KEY` | Your AWS secret access key.                   |

| `STORAGES_AWS_BUCKET_NAME`       | The bucket name that you want to use.         |

> In case you encounter any problems with finding your AWS credentials please read [this page][1] as a reference.

## Google Cloud Storage

| Environment variable                | Value                                                               |

|-------------------------------------|---------------------------------------------------------------------|

| `STORAGES_BACKEND`                  | `storages.backends.google_cloud.GoogleCloudStorage`                 |

| `STORAGES_GOOGLE_CLOUD_CREDENTIALS` | Your Google Cloud Storage credentials in JSON encoded using Base64. |

| `STORAGES_GOOGLE_CLOUD_BUCKET_NAME` | The bucket name that you want to use.                               |

# Documentation

The documentation is hosted on the project's [GitHub Wiki][2].

[1]: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html "Understanding and getting your AWS credentials"

[2]: https://github.com/merixstudio/simple-storage/wiki