Skip to content

nullhack/openfaas-fastapi-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Contributors Forks Stargazers Issues MIT License


openfaas-fastapi-template

Python template for OpenFAAS functions using FastAPI
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

Python template for OpenFAAS functions using FastAPI. This template has two flavours, a simple project using fastapi and a more complex with authentication using JWE (encrypted JWT) for improved security.

(back to top)

Getting Started

To run this project locally, you will need to install the prerequisites and follow the installation section.

Prerequisites

  • This Project depends on OpenFAAS
    curl -sSL https://cli.openfaas.com | sudo -E sh

Installation

  1. Pull the template

    faas template pull https://github.com/nullhack/openfaas-fastapi-template/
  2. Create a new function

    faas new --lang openfaas-fastapi-template myf

    or

    faas new --lang openfaas-fastapi-jwe-template myf
  3. Include the function name as environment variable into the myf.yml file

    ...
        environment:
          FUNCNAME: myf
    ...
  4. build and publish the function to the server

    faas up -f myf.yml

(back to top)

Alternative Usage

It's possible to directly use the template without OpenFAAS or to test it before pushing to the server.

  • Install requirements

    pip install poethepoet poetry
    # go to the function folder
    poe install-dev
  • Run tests

    poe test
  • Generate API documentation

    poe doc
  • Build a docker image for tests

    poe docker-build --target test --build-tag 3.10-alpine
    docker run -ti --rm handler:test-3.10-alpine
  • Build a docker image to run the root files only without running any test

    poe docker-build --target prod --build-tag 3.10-alpine --no-test
    docker run -ti --rm handler:prod-3.10-alpine

For more examples, please refer to the Documentation

(back to top)

Roadmap

  • Improve JWE template coverage

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

Contact

Eric Lopes - @nullhack

Project Link: https://github.com/nullhack/openfaas-fastapi-template/

(back to top)

Acknowledgments

This project was created using cookiecutter and nullhack's python-project-template:

(back to top)

License

Distributed under the MIT License. See LICENSE for more information.

(back to top)