Package: keyfactor-v-1-client
keyfactor-v-1-clientA client library for accessing Keyfactor-v1InstallUsing pippipinstallkeyfactor-v-1-clientFrom sourcegitclonehttps://github.com/Keyfactor/keyfactor-python-client-sdk.gitcdkeyfactor-python-client-sdk/kfclient
poetryinstall# Alternativelypython-mpipinstall.ConfigUsing Environment VariablesexportKEYFACTOR_HOSTNAME=<hostname># e.g. https://keyfactor.example.comexportKEYFACTOR_USERNAME=<username># e.g. adminexportKEYFACTOR_PASSWORD=<password># e.g. passwordexportKEYFACTOR_DOMAIN=<domain># e.g. example.comUsing a Config FileexportKEYFACTOR_CONFIG=<pathtoconfigfile># e.g. /etc/keyfactor/config.json. Defaults to cwd "environment.json"Sample Config:{"host":"<hostname>","username":"<username>","password":"<password>","domain":"<domain>"}UsageFirst, create a client:fromkeyfactor_v_1_clientimportClientclient=Client(base_url="https://api.example.com")If the endpoints you're going to hit require authentication, useAuthenticatedClientinstead:fromkeyfactor_v_1_clientimportAuthenticatedClientclient=AuthenticatedClient(base_url="https://api.example.com",token="SuperSecretToken")Now call your endpoint and use your models:fromkeyfactor_v_1_client.modelsimportMyDataModelfromkeyfactor_v_1_client.api.my_tagimportget_my_data_modelfromkeyfactor_v_1_client.typesimportResponsemy_data:MyDataModel=get_my_data_model.sync(client=client)# or if you need more info (e.g. status_code)response:Response[MyDataModel]=get_my_data_model.sync_detailed(client=client)Or do the same thing with an async version:fromkeyfactor_v_1_client.modelsimportMyDataModelfromkeyfactor_v_1_client.api.my_tagimportget_my_data_modelfromkeyfactor_v_1_client.typesimportResponsemy_data:MyDataModel=awaitget_my_data_model.asyncio(client=client)response:Response[MyDataModel]=awaitget_my_data_model.asyncio_detailed(client=client)By default, when you're calling an HTTPS API it will attempt to verify that SSL is working correctly. Using certificate
verification is highly recommended most of the time, but sometimes you may need to authenticate to a server (especially
an internal server) using a custom certificate bundle.client=AuthenticatedClient(base_url="https://internal_api.example.com",token="SuperSecretToken",verify_ssl="/path/to/certificate_bundle.pem",)You can also disable certificate validation altogether, but beware thatthis is a security risk.client=AuthenticatedClient(base_url="https://internal_api.example.com",token="SuperSecretToken",verify_ssl=False)Things to know:Every path/method combo becomes a Python module with four functions:sync: Blocking request that returns parsed data (if successful) orNonesync_detailed: Blocking request that always returns aRequest, optionally withparsedset if the request
was successful.asyncio: Likesyncbut async instead of blockingasyncio_detailed: Likesync_detailedbut async instead of blockingAll path/query params, and bodies become method arguments.If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)Any endpoint which did not have a tag will be inkeyfactor_v_1_client.api.defaultBuilding / publishing this ClientThis project usesPoetryto manage dependencies and packaging. Here are the basics:Update the metadata in pyproject.toml (e.g. authors, version)If you're using a private repository, configure it with Poetrypoetry config repositories.<your-repository-name> <url-to-your-repository>poetry config http-basic.<your-repository-name> <username> <password>Publish the client withpoetry publish --build -r <your-repository-name>or, if for public PyPI,
justpoetry publish --buildIf you want to install this client into another project without publishing it (e.g. for development) then:If that projectis using Poetry, you can simply dopoetry add <path-to-this-client>from that projectIf that project is not using Poetry:Build a wheel withpoetry build -f wheelInstall that wheel from the other projectpip install <path-to-wheel>