Skip to content

Commit f87cfd3

Browse files
author
Tomasz Szymański
committed
readme updated
1 parent e9a8359 commit f87cfd3

1 file changed

Lines changed: 46 additions & 16 deletions

File tree

README.md

Lines changed: 46 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,46 @@
1-
# Simple Storage
2-
3-
File storage made simple.
4-
5-
[![codecov](https://codecov.io/gh/merixstudio/simple-storage/branch/master/graph/badge.svg?token=XMH3S6M34G)](https://codecov.io/gh/merixstudio/simple-storage)
6-
7-
![python](https://img.shields.io/badge/Python-3.6%2B-brightgreen)
8-
9-
## Supported backends
10-
11-
- File system storage
12-
- AWS S3
13-
14-
## Requirements
15-
16-
- Python >= 3.6
1+
# Simple Storage
2+
3+
File storage made simple.
4+
5+
[![codecov](https://codecov.io/gh/merixstudio/simple-storage/branch/master/graph/badge.svg?token=XMH3S6M34G)](https://codecov.io/gh/merixstudio/simple-storage)
6+
7+
![python](https://img.shields.io/badge/Python-3.6%2B-brightgreen)
8+
9+
## Supported storages
10+
11+
- File system
12+
- AWS S3
13+
14+
## Requirements
15+
16+
- Python >= 3.6
17+
18+
# How to use
19+
20+
Install the package:
21+
22+
```shell
23+
pip install simple-storage
24+
```
25+
26+
Now, depending on the storage you want to use, follow the instructions below.
27+
28+
## File system storage
29+
30+
| Environment variable | Value |
31+
|----------------------|---------------------------------------------------------------------|
32+
| `STORAGES_BACKEND` | `storages.backends.file_system.FileSystemStorage` |
33+
| `STORAGES_PATH` | Point to the existing path in your file system, e.g. `/app/media`. |
34+
35+
## AWS S3 storage
36+
37+
| Environment variable | Value |
38+
|----------------------------------|-----------------------------------------------|
39+
| `STORAGES_BACKEND` | `storages.backends.amazon_s3.AmazonS3Storage` |
40+
| `STORAGES_AWS_ACCESS_KEY_ID` | Your AWS access key ID. |
41+
| `STORAGES_AWS_SECRET_ACCESS_KEY` | Your AWS secret access key. |
42+
| `STORAGES_BUCKET_NAME` | The bucket name that you want to use. |
43+
44+
> In case you encounter any problems with finding your AWS credentials please read [this page][1] as a reference.
45+
46+
[1]: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html "Understanding and getting your AWS credentials"

0 commit comments

Comments
 (0)