Clarifai logo

clarifai-python-utils

This is the official Clarifai Python utilities project. This repo includes higher level convenience classes, functions, and scripts to make using our API easier. This is built on top of the Clarifai Python gRPC Client.

Try the Clarifai demo at: https://clarifai.com/demo
Sign up for a free account at: https://clarifai.com/signup
Read the documentation at: https://docs.clarifai.com/

Installation

pip install -U clarifai-utils

Installation from source (for development)

python -m venv ~/virtualenv/clarifai-python-utils
source ~/virtualenv/clarifai-python-utils/bin/activate
cd clarifai-python-utils
python setup.py develop

Versioning

This library doesn't use semantic versioning. The first two version numbers (X.Y out of X.Y.Z) follow the API (backend) versioning, and whenever the API gets updated, this library follows it.

The third version number (Z out of X.Y.Z) is used by this library for any independent releases of library-specific improvements and bug fixes.

Getting started

Here is a quick example of listing all the concepts in an application.

Set some env vars first

export CLARIFAI_USER_ID={the user_id of the app_id of the app you want to access resources in}
export CLARIFAI_APP_ID={the app_id of the app you want to access resources in}
export CLARIFAI_PAT={your personal access token}

from clarifai_utils.client import create_stub
from clarifai_utils.listing.lister import ClarifaiResourceLister

# Create a client with auth information from those env vars.
stub = create_stub()

# Create the resource lister.
lister = ClarifaiResourceLister(stub, auth.user_id, auth.app_id, page_size=16)

# List all the concepts in the app:
concepts = []
for c in lister.concepts_generator():
  concepts.append(c)

Testing

pip install tests/requirements.txt
pytest tests/

Linting

The repo will be linted when changed in a github workflow. To speed up development it's recommended to install pre-commit and tools

pip install -r requirements-dev.txt
pre-commit install

You could run all checks by

pre-commit run --all-files

Metadata

Release files for clarifai-utils 0.1.20

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for clarifai-utils 0.1.20
File	Size	Uploaded
clarifai-utils-0.1.20.tar.gz	19.5 kB	Dec 21, 2022	Details

Built distribution (wheel)

Table of built distributions (wheels) for clarifai-utils 0.1.20
File	Interpreter	ABI	Platform	Reset
clarifai_utils-0.1.20-py3-none-any.whl 26.2 kB Dec 21, 2022	Python 3	none	any	Details

Total release size: 45.7 kB

Release files / clarifai-utils-0.1.20.tar.gz

Download URL	clarifai-utils-0.1.20.tar.gz
Size	19.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`d256e27be71cf94ec6bb2952e20890eb0af25b91c4b068e02d4ca5c8adba1dda`
BLAKE2b-256 checksum How to use checksums	`1f23515431c6878f7ace76f97f2349275e9a2bd61fbfabe8442f5820c516df3b`
Upload date	Dec 21, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.7.6`

Release files / clarifai_utils-0.1.20-py3-none-any.whl

Download URL	clarifai_utils-0.1.20-py3-none-any.whl
Size	26.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`509d607d53c49b0b52cd4a46eff1281b6879f02cb89b0322dc76c032ebc61687`
BLAKE2b-256 checksum How to use checksums	`5b39cbbcc3e624805db6ea0486933b9b27317984f1cbbf4e042cc08977385258`
Upload date	Dec 21, 2022
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/4.0.1 CPython/3.7.6`