Skip to main content

An ready to use exposer from services oriented code

Project description

Grui

Generated Rest User Interface

This package allow developer to expose function to the web. GRUI will generate a Rest API from the class. An HTTP page will also be generated. The main idea is to focus the code on the functionality.

Code examples

from typing import *

from grui import GruiService
from grui.decorator import *

class MySuperService(GruiService):
    """The documentation will be available to end user.

    Longer description will be display into the help page of the service.
    """

    @Get("my-super-path")
    @NotFoundIfEmpty  # Set the http return code to 404 if it return None. 
    def get_all(self) -> Optional[List[int]]:
        """The method documentation is display to the user as well"""
        return self.whatever

Issues/Bug report or improvement ideas

https://gitlab.com/olive007/grui/-/issues

License

GNU Lesser General Public License v3 or later (LGPLv3+)

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

grui-0.0.10.tar.gz (14.2 kB view details)

Uploaded Source

File details

Details for the file grui-0.0.10.tar.gz.

File metadata

  • Download URL: grui-0.0.10.tar.gz
  • Upload date:
  • Size: 14.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.25.0 setuptools/50.3.2 requests-toolbelt/0.9.1 tqdm/4.53.0 CPython/3.9.0

File hashes

Hashes for grui-0.0.10.tar.gz
Algorithm Hash digest
SHA256 074f188377cb4c9a9b6adf7e4fd75b5aa7b6336b23f255383378a7d59945e06b
MD5 2b1129c50a2ea9123669050f0f4ef292
BLAKE2b-256 6dbcae3e07778c2f353bea9f8d136c507c959dc829b18708b10f4b6a48b8323d

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