Skip to content

Latest commit

 

History

History
109 lines (80 loc) · 3.91 KB

README.md

File metadata and controls

109 lines (80 loc) · 3.91 KB
Raw

Render API Wrapper - Python

Python wrapper for Render Deployment API - actively supported by AppSeed.


Roadmap - see VIDEO Presentation

Item Python Info
Deploy Static Site ✅ docs
Deploy Web Service Flask ✅ docs
Deploy Web Service Django ✅ docs
Deploy Web Service NodeJS ✅ docs
--- --- ---
AppSeed Specific --- ---
Deploy Flask API Service ✅ docs
Deploy Django API Service ✅ docs
Deploy NodeJS API Service ✅ docs
Deploy FullStack Service ✅ docs

How to use it

Install modules

$ virtualenv env
$ source env/bin/activate
$ pip install -r requirements.txt

Export Variables

Unix / MacOs environment

$ export RENDER_API_KEY=<RENDER_API_KEY>     # mandatory
$ export RENDER_OWNER_ID=<RENDER_OWNER_ID>   # optional
$ export RENDER_BUILDER='yarn'               # optional, <NPM or YARN>, defaults to NPM
$ export DEBUG=1                             # enables verbose output

Windows CMD environment

$ set RENDER_API_KEY=<RENDER_API_KEY>        # mandatory
$ set RENDER_OWNER_ID=<RENDER_OWNER_ID>      # optional
$ set RENDER_BUILDER='yarn'                  # optional, <NPM or YARN>, defaults to NPM
$ set DEBUG=1                                # enables verbose output

Windows Powershell environment

$ $env:RENDER_API_KEY = "<RENDER_API_KEY>"   # mandatory
$ $env:RENDER_OWNER_ID = "<RENDER_OWNER_ID>" # optional
$ $env:RENDER_BUILDER = "yarn"               # optional, <NPM or YARN>, defaults to NPM
$ $env:DEBUG = "1"                           # enables verbose output

EXEC API

Item Info Sample Output HELP
python deployer.py CLI Help Usage: runner.py COMMAND ARGS -
python deployer.py check Print API_KEY rnd_TgN*** -
python deployer.py all_owners Print all owners ['usr-cct***', 'tea-cct***'] -
python deployer.py owner Get First Owner rnd_TgN*** -
--- --- --- -
python deployer.py nodejs REPO_URL Deploy NodeJS > Deploy [dep-cdg***] -
--- --- --- -
python deployer.py django REPO_URL Deploy Django > Deploy [dep-cdg***] -
--- --- --- -
python deployer.py flask REPO_URL Deploy Flask > Deploy [dep-cdg***] -
--- --- --- -
python deployer.py static REPO_URL Deploy React, Vue > Deploy ID [dep-cdg***] -
--- --- --- -
python deployer.py nodejs_api <REPO_URL> Repo NodeJS API > Deploy [dep-cdg***] docs
python deployer.py flask_api <REPO_URL> Repo Flask API > Deploy [dep-cdg***] docs
python deployer.py django_api <REPO_URL> Repo Django API > Deploy [dep-cdg***] docs

Flask Sample

Flask Star Admin

In order to have a successful deploy, the environment should contain API_KEY and OWNER_ID (credit card attached)

$ python.exe .\deployer.py flask https://github.com/app-generator/flask-star-admin

In the above sample, "run:app" is used as WSGI entry point.


Render API Wrapper - Free Tool provided by AppSeed