https://github.com/mathix420/pylone

Simple, lightweight, AWS serverless CD framework.
https://github.com/mathix420/pylone

aws-lambda cicd continuous-deployment lambda lambda-functions pylone python3

Last synced: about 2 months ago
JSON representation

Simple, lightweight, AWS serverless CD framework.

• Host: GitHub
• URL: https://github.com/mathix420/pylone
• Owner: mathix420
• Created: 2019-11-21T19:31:44.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-08-21T18:55:30.000Z (5 months ago)
• Last Synced: 2024-11-04T19:52:48.848Z (2 months ago)
• Topics: aws-lambda, cicd, continuous-deployment, lambda, lambda-functions, pylone, python3
• Language: Python
• Homepage:
• Size: 76.2 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


# PYLONE

**Python CD framework**

[![Pypi](https://badgen.net/pypi/v/pylone)](https://pypi.org/project/pylone/)

[![Docker Pulls](https://badgen.net/docker/pulls/plsr/pylone?icon=docker&label=pulls)](https://hub.docker.com/r/plsr/pylone/)

[![wakatime](https://wakatime.com/badge/github/mathix420/pylone.svg)](https://wakatime.com/badge/github/mathix420/pylone)

[![Maintainability](https://api.codeclimate.com/v1/badges/fc078176e896556db324/maintainability)](https://codeclimate.com/github/mathix420/pylone/maintainability)

# Features

- Publish, update and delete Lambdas

- Publish, update and delete Layers

- [Doppler](https://doppler.com) integration

- Simple and light wieght

- Multi stages lambdas

- Before/after deploy hooks

# Install

```bash

pip install pylone

```

# Usage

## Pylone usage

```bash

pylone -h

```

# Template reference

## `stages` global parameter

You can set the `stages` parameter to have a multistage project

```yaml

stages:

    - dev # first one is used as default stage

    - prod # all other stages are more advanced stages

```

## `source` parameter

You can use the `source` parameter to force a directory to be used as source

```yaml

source: ./bin

```

## `before-script` parameter

You can use the `before-script` parameter to execute a bash script before processing an entity

```yaml

before-script: ./script.sh

# OR

before-script: "echo 'Starting ...'"

```

## `after-script` parameter

Similar as `before-script` but launch script at the end of process

```yaml

after-script: ./script.sh

# OR

after-script: "echo 'END of process'"

```

## `bucket-name` parameter

> Default value: `pylone-bucket`

Allows you to choose the bucket name where pylone will upload zip files.

```yaml

bucket-name: tmp-pylone-files

```

# DX

## VSCode config

`.vscode/settings.json`

```json

{

    "yaml.customTags": [

        "!env scalar"

    ]

}

```

# Dev Guide

## Deploy new version

1. Bump version in [`setup.py`](/setup.py)

2. Commit and push to master

3. Create a new github release + tag using this format `vX.X.X`

4. Github Action will take care of the rest!