Skip to main content

Create a Serverless service in Git hosting

Project description

GitFx - Create a Serverless service in Git hosting

GitFx Testing GitFx Lint

GitFx can be used to run some functions and serve the output as a service in a Git hosting.

GitFx is a Python lib extracted from an action ActionServerless. And now the action uses this lib as a dependency to do the real job, you can run the lib locally in a same way as in the action.

Prerequisites

  • Python 3.5+
  • Docker

Install

pip3 install gitfx

# or
python3 -m pip install gitfx

Note: Python 2 is not supported

Usage

Let's start with a Python code that'll be used to create a Serverless service:

# function.py
import json

# GET /api/py_hello.json

print(json.dumps({"hello": "world"}))

put the program to a path under current directory, for example, test folder and run:

python3 -m gitfx test/
# you can pass more folders if you have

then the program's output is written to a file located in api/py_hello.json that you defined as a route in the comment.

You can use the ActionServerless to run functions in GitHub, and also you can run locally as above example then push the generated files to the remote.

more languages' examples you can find here.

Languages supported

Language Dependency Installation Version Management Example code
Python requirements.txt .python-version pyenv See
Ruby Gemfile .ruby-version rvm/rbenv See
Node.js package.json .nvmrc nvm See
Perl cpanfile .perl-version plenv See
PHP composer.json .phpenv-version phpenv See
Golang ⬜️ ⬜️ See
Haskell ⬜️ ⬜️ See
Elixir ⬜️ ⬜️ See
Bash -- -- See
Rust ⬜️ ⬜️ See
  • ✅ Feature supported
  • ⬜ Feature not supported yet
  • -- N/A

Documents

Real world examples

Contributions

Contributions are welcome! You may check the following features in case you'd like to contribute but no idea what to do:

  • Support to add your favorite languages
  • Support dependency installation to the existing languages
  • Use this action to create an application and share it

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

GitFx-0.0.6.tar.gz (9.8 kB view details)

Uploaded Source

Built Distribution

GitFx-0.0.6-py3-none-any.whl (10.8 kB view details)

Uploaded Python 3

File details

Details for the file GitFx-0.0.6.tar.gz.

File metadata

  • Download URL: GitFx-0.0.6.tar.gz
  • Upload date:
  • Size: 9.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.11

File hashes

Hashes for GitFx-0.0.6.tar.gz
Algorithm Hash digest
SHA256 5544a59814faf5c3fa7298174630d4a40c52860da935844758fd7b9f4617e7e5
MD5 391c1190f06dd3706598499aa867686a
BLAKE2b-256 91992179e39963ed24305adbeae934f77a3b5fa5e324b74299acba346d879f42

See more details on using hashes here.

File details

Details for the file GitFx-0.0.6-py3-none-any.whl.

File metadata

  • Download URL: GitFx-0.0.6-py3-none-any.whl
  • Upload date:
  • Size: 10.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.6.0 importlib_metadata/4.8.2 pkginfo/1.8.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.8.11

File hashes

Hashes for GitFx-0.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 a62f6566c63eea7a452a44df22aea0b7e0b88053c6551420ef4c60767c99a62e
MD5 277d234946aa952cdb0aef195c6a35de
BLAKE2b-256 a3e237aae899aa27c6606e51ba0a0542c89585ef96ff6e02b0e6fbe9ebc3a2e8

See more details on using hashes here.

Supported by

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