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()

There also exists Python client for APIer in ci_cd_apier.client package.

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-2.0.0.tar.gz (757.7 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-2.0.0-py3-none-any.whl (767.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for ci_cd_apier-2.0.0.tar.gz
Algorithm Hash digest
SHA256 07b01365afc127dd48e79f0a410f5410beb64d10ae8507cde44b10fe2583a9da
MD5 115a29ee5b9de8630eb6fdd0811c2fe5
BLAKE2b-256 322c7e8edab8e40b525605b7c6863adc7a8a32d94e6457db3a44e6f109a2d09a

See more details on using hashes here.

Provenance

The following attestation bundles were made for ci_cd_apier-2.0.0.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-2.0.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for ci_cd_apier-2.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 01bd1d994f9c77050818a504d79209d52003be305b5dd53b07201b8f6cac8cd2
MD5 f9d3d247a3a5de28f695bed46a26fa68
BLAKE2b-256 0e4d073c69972d0ee81699fcaa1babcab4d22866c86ec424564eb89f2dfe2363

See more details on using hashes here.

Provenance

The following attestation bundles were made for ci_cd_apier-2.0.0-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