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.91.tar.gz (745.4 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.91-py3-none-any.whl (753.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: ci_cd_apier-0.9.91.tar.gz
  • Upload date:
  • Size: 745.4 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.91.tar.gz
Algorithm Hash digest
SHA256 3ecaf23fa2733b2a673d604101d2e161e291d41f328fc9768a5e4a7464f2b778
MD5 6879ff89ab149b42885fa80f050fc17e
BLAKE2b-256 b39d15f3e40ff845bd342154db62727e0b57fc3c9b97ad99bf4015b6c1c597ac

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: ci_cd_apier-0.9.91-py3-none-any.whl
  • Upload date:
  • Size: 753.8 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.91-py3-none-any.whl
Algorithm Hash digest
SHA256 37629a5086a627dcefb64d9d5c2703f1540203d4b62f73dfc5f888dfc7f5547c
MD5 ca76782f081723962db745a6d56689a9
BLAKE2b-256 6c0aa112baf25bbdeb7089ac965b6dc16f29f48d52b419a1cad0e99261685967

See more details on using hashes here.

Provenance

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