Functions-Client
This CLI tool is used for uploading and managing Functions in CIM Database Cloud.
Information on how build Functions can be found in the Functions-SDK documentation: https://cslab.github.io/functions-sdk-python/
Requirements
Python 3.10+
Installation
$ pip install contactsoftware-functions-client
Login
Before you can create environments or deploy Functions you need to login using your client-id and secret. Obtain your client credentials via the CONTACT Portal.
$ cfc login --client-id <client_id> --client-secret <client_secret>
The credentials will be stored in a configuration file. The storage location of the configuration file depends on the OS:
- Windows:
C:\Users\<username>\AppData\Local\Contact\cfc\config.ini - Linux:
~/.config/cfc/config.ini
Features
Manage Function environments
Functions are grouped into environments, which are the (Docker) container the code runs in. An environment contains a runtime for its specific programming language, the Function code and a configuration file describing the environment.
Create a new environment:
$ cfc env create <environment_name>
Display a list of all environments:
$ cfc env list
Display the details of an environment:
$ cfc env describe <environment_name>
Deploy Function code into an environment
To deploy Function code into an existing environment run:
$ cfc env deploy <environment_name>
Make sure you run the command from within the directory that contains the environment.yaml configuration file.
Information on how to build Function code can be found in the documentation of the Functions-SDK: https://cslab.github.io/functions-sdk-python/
Metadata
Release files for contactsoftware-functions-client 0.5.5
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| contactsoftware_functions_client-0.5.5.tar.gz | 6.6 kB | Without provenance | Details for contactsoftware_functions_client-0.5.5.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| contactsoftware_functions_client-0.5.5-py3-none-any.whl | Python 3 | none | any | Details for contactsoftware_functions_client-0.5.5-py3-none-any.whl |
Total release size: 15.3 kB
Release files / contactsoftware_functions_client-0.5.5.tar.gz
| Download URL | contactsoftware_functions_client-0.5.5.tar.gz |
|---|---|
| Size | 6.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
7b081ee3bf0618e4c4a558a1bf508dbe52b3fe61675be6c97d28b6ce5b78a05b
|
|
BLAKE2b-256 checksum How to use checksums |
54eaee7975f8b651704ec19dc9f031b814834cd6e2acc752c6cb248e2874c16f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.0 CPython/3.11.15 Linux/6.17.0-1010-azure
|
Release files / contactsoftware_functions_client-0.5.5-py3-none-any.whl
| Download URL | contactsoftware_functions_client-0.5.5-py3-none-any.whl |
|---|---|
| Size | 8.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
697d7ec2760c0b765447201fc0f90ad195b9e7567cb0cc888ae2fcabbb3a9f06
|
|
BLAKE2b-256 checksum How to use checksums |
03f6c42bc5ca757901cad55de139e2c0af8855db4eeb6a8f32af5d89f689d95e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.4.0 CPython/3.11.15 Linux/6.17.0-1010-azure
|
Security for contactsoftware-functions-client 0.5.5
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.