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-0.9.99.tar.gz (746.1 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-0.9.99-py3-none-any.whl (754.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ci_cd_apier-0.9.99.tar.gz
  • Upload date:
  • Size: 746.1 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-0.9.99.tar.gz
Algorithm Hash digest
SHA256 9bb6ca1ce9e1c4d8730547f22fd7deceb76231d6456d72a141dfb76ecca83cf5
MD5 28555b0643a125eb53c49c6d378f6f2d
BLAKE2b-256 b2e28f497bf5223bc5ffb9619183ef0a1515e283889c416516f4a3017f8076ec

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: ci_cd_apier-0.9.99-py3-none-any.whl
  • Upload date:
  • Size: 754.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-0.9.99-py3-none-any.whl
Algorithm Hash digest
SHA256 c8caa637ccab6c5066c2ff4ab680b3f10ecec08b2ce820611edf70aed327e006
MD5 b7139c5d0ea5289f213157509943f83a
BLAKE2b-256 1c8066555509a390c7816c92fad241b73e459ec0dd0d5e86a4b5edf53814be55

See more details on using hashes here.

Provenance

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