Welcome to django-storages-ec2’s documentation!

django-storages-ec2

https://img.shields.io/travis/cdriehuys/django-storages-ec2.svg https://img.shields.io/gemnasium/cdriehuys/django-storages-ec2.svg https://img.shields.io/codecov/c/github/cdriehuys/django-storages-ec2.svg https://img.shields.io/pypi/v/django-storages-ec2.svg

Extension for django-storages when running on EC2 instances.

Project Home Page:
https://github.com/cdriehuys/django-storages-ec2
Documentation:
http://django-storages-ec2.readthedocs.io
Issues:
https://github.com/cdriehuys/django-storages-ec2/issues

Rationale

Using S3 to store static files makes a lot of sense. The django-storages app makes this easy. What doesn’t make sense is having to provide dedicated credentials to allow S3 access when the project is already running on an EC2 instance. This app allows you to use the IAM role attached to your EC2 instance to grant the instance access to S3.

Development

To get started with development, clone the repository and install the requirements:

$ git clone https://github.com/cdriehuys/django-storages-ec2
$ cd django-storages-ec2
$ python setup.py install
$ pip install -r requirements-dev.txt

Contributing

Contributions to this project are welcome. If you would like to add on a feature, create a branch, commit your changes, and submit a pull request:

$ git checkout -b my-new-feature
$ ...
$ git commit -a -m 'Add my new feature'

Tests

Tests are run with pytest. You can run the project’s tests by running:

$ pytest

Tests are automatically run with Travis CI. In addition to running the tests, it will also lint the project’s code with flake8.

License

This project is licensed under the MIT license.

Indices and tables