Skip to main content

ci-cd-APIer -- Flask-like API framework for GitLab CI/CD pipelines

Project description

ci-cd-APIer

APIer is a library that allows you to launch its backend code with Flask-like syntax using GitLab CI/CD. All the requests and responses are processed with e2e encryption using age, so nobody has access to the data except the sender (web page) and the receiver (GitLab job in memory).

Usage example

To see the full example, take a look at the example repository.

Whenever the client calls a backend via APIer script, e.g.:

const APIer = new APIer(
    '$AGE_PUBLIC_KEY$',
    '$GITLAB_PIPELINE_ENDPOINT$',
    '$GITLAB_TOKEN$'
);

const totalSum = await APIer.sendRequest('sumNumbers', [1, 2, 3, 4, 5]);

A pipeline is triggered. Example code that handles the request in the pipeline may be:

app = APIER(environ["AGE_SECRET_KEY"])

@app.route("echo")
def endpoint_echo(data: any) -> str:
    return f"You said: {data}. Enjoy :)"
    
@app.route("sumNumbers")
def endpoint_sum(data: list[int]) -> str:
    return str(sum(data))

app.process_requests()

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

ci_cd_apier-1.0.1.tar.gz (746.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ci_cd_apier-1.0.1-py3-none-any.whl (755.7 kB view details)

Uploaded Python 3

File details

Details for the file ci_cd_apier-1.0.1.tar.gz.

File metadata

  • Download URL: ci_cd_apier-1.0.1.tar.gz
  • Upload date:
  • Size: 746.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for ci_cd_apier-1.0.1.tar.gz
Algorithm Hash digest
SHA256 b489e580e8c981e3917c07f0b16093e323c8cc06696337349ad8a25e4c77f974
MD5 d401d843123dceed2d7a51062cd588de
BLAKE2b-256 310acb4a396b3641f782000bc82921e935640f5af9b0a1555717838f5be038ad

See more details on using hashes here.

Provenance

The following attestation bundles were made for ci_cd_apier-1.0.1.tar.gz:

Publisher: pypi-deploy.yml on esoadamo/ci-cd-apier

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file ci_cd_apier-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: ci_cd_apier-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 755.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for ci_cd_apier-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 6ef35720a64aea8f2e48406d13e0747903f8fa0fdf1fc5c230074385a3b4ef6c
MD5 38fdd732d8c03f46abc5fff75510f16c
BLAKE2b-256 be4fa20ba9e2e06c9c246277816f111bf94a5c6081ff9ab4818f4eef96285321

See more details on using hashes here.

Provenance

The following attestation bundles were made for ci_cd_apier-1.0.1-py3-none-any.whl:

Publisher: pypi-deploy.yml on esoadamo/ci-cd-apier

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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