Skip to main content

Helpers for Django Zappa deployments

Project description

# zappa-django-utils

[![PyPI](https://img.shields.io/pypi/v/zappa-django-utils.svg)](https://pypi.python.org/pypi/zappa-django-utils)
[![Slack](https://img.shields.io/badge/chat-slack-ff69b4.svg)](https://slack.zappa.io/)
[![Gun.io](https://img.shields.io/badge/made%20by-gun.io-blue.svg)](https://gun.io/)
[![Patreon](https://img.shields.io/badge/support-patreon-brightgreen.svg)](https://patreon.com/zappa)


Small utilities for making [Zappa](https://github.com/Miserlou/Zappa) deployments slightly easier for Django applications.

This project was inspired by Edgar Roman's [Zappa Django Guide](https://github.com/edgarroman/zappa-django-guide).

## Installation

Install via `pip`:

$ pip install zappa-django-utils

Add to your installed apps:

INSTALLED_APPS += ('zappa_django_utils',)

## Usage

### Using an S3-Backed Database Engine

**ZDU** includes the ability to use a S3-synced SQLite database as a Django database engine.

To use this, in your Django project's `settings.py` file, add the following:

```python
DATABASES = {
'default': {
'ENGINE': 'zappa_django_utils.db.backends.s3sqlite',
'NAME': 'sqlite.db',
'BUCKET': 'your-db-bucket'
}
}
```

And.. that's it!

### Creating a Postgres Database

Once you have your RDS set up, your VPC/Subnet/Security Groups set up, and your `DATABASES` setting set up, you can create the database with:

$ zappa manage <stage> create_pg_db

Then you're ready to `python manage.py makemigrations` and `zappa update; zappa manage migrate`!

### Creating a Default Admin User

You'll probably need a default user to manage your application with, so you can now:

$ zappa manage <stage> create_admin_user

Now log in with the information that gets returned and immediately change the admin user's email and password.

### Creating/Dropping a Postgres Schema

You can create a [Postgres schema](https://www.postgresql.org/docs/current/static/ddl-schemas.html) with:

$ zappa manage create_pg_schema

and drop it with:

$ zappa manage drop_pg_schema

## License

(c) 2017, Rich Jones, MIT License

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

zappa-django-utils-0.3.0.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

zappa_django_utils-0.3.0-py2-none-any.whl (10.6 kB view details)

Uploaded Python 2

File details

Details for the file zappa-django-utils-0.3.0.tar.gz.

File metadata

File hashes

Hashes for zappa-django-utils-0.3.0.tar.gz
Algorithm Hash digest
SHA256 5cc6530a81a3dd72d4869a8af1385a4f28810e7f150ccf238139117b99a1b1c7
MD5 e9baf066998fb11c8342f906c6bc7c1c
BLAKE2b-256 2e567c80c1bf29c05c08156abe9d72436fc11f77a73a625658ea82f6e1fe89b3

See more details on using hashes here.

File details

Details for the file zappa_django_utils-0.3.0-py2-none-any.whl.

File metadata

File hashes

Hashes for zappa_django_utils-0.3.0-py2-none-any.whl
Algorithm Hash digest
SHA256 77c863e459341b60ee189530ce9000c1ae641b3a961e4461f422203bd74bb822
MD5 c25059b67913e555dd8925434a2bceb8
BLAKE2b-256 595cd29df752d962e54c477f96eb2eb9a006b07c7d71ec5edc22ed1aae39e8ea

See more details on using hashes here.

Supported by

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