Metadata-Version: 2.1
Name: zappadock
Version: 0.1.5
Summary: A tool for running Zappa commands in a Lambda-like' environment.
Home-page: https://github.com/dickermoshe/zappadock
Author: Moshe Dicker
Author-email: dickermoshe@gmail.com
License: GNU General Public License v3.0
Platform: UNKNOWN
Requires-Python: >=3.6,!=3.10.*,!=3.11.*
Description-Content-Type: text/markdown
License-File: LICENCE

# [ZappaDock](https://pypi.org/project/zappadock/)
## About
This package makes dealing with [Zappa](https://github.com/zappa/Zappa) a walk in the park.
#### How ?
Zappa runs Flask/Django web apps on AWS Lambda.  
We LOVE Zappa. However it's not the MOST user-friendly application ever.
#### Why ?
You see, Zappa builds all your requirements before uploading your app to AWS Lambda. However, pip downloads the packages that are compatible with the computer it is running on, so when Zappa uploads it to AWS Lambda, many packages don't work (notably `psycopg2` among others).
#### What's the solution ?
The solution recommend by the [The Django Guide for Zappa](https://romandc.com/zappa-django-guide/) is to run your Zappa commands in a docker container similar to the one that AWS Lambda uses.  
This will ensure that all the dependencies will be AWS Lambda compatible. 
This ZappaDock streamlines the workflow.
#### What Does ZappaDock Do ?
ZappaDock does 3 things.
1. Run a docker container with your code mounted.
2. Recognize your AWS credentials and load them into the container.
3. Create and activate a virtual environment inside the container.  

So now you can test and deploy your code confident that it will work once deployed.  


## Install 
It's dead simple :
```
$ pip install zappadock
```


## Usage 
1. Make sure Docker is installed by running `docker info` command from a terminal.
2. Set your AWS credentials in environmental variables or in the `~/.aws/credentials` file.  See the [Amazon Docs](https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html#environment-variables) for more information.
3. Run `zappadock` in the directory you wish to run your Zappa commands.  
Your directory will be loaded in a docker container, and a virtual environment will be created and activated.  

If you have any problems, open a issue and we'll figure it out.


## Contributing
I mostly made this for myself.  If you want to help make this a masterpiece, be a sport and contribute.  
Thanks!



