Featureform Python Client
Overview
Featureform’s Python client is a SDK for defining, managing and serving resources (e.g. infrastructure providers, data sources, transformations, etc.). At a high level, the API is divided into two parts:
- Registration: register data stores (e.g. PostgreSQL), data sources (e.g. tables or CSV files) as resources or get and/or list previously registered resources
- Serving: retrieve training sets and features for offline training or online inference
Requirements
- Python 3.9-3.12
Setting Up Your Local Development Environment
Step 1: Install gRPC and Protocol Buffer Tooling
See grpc.io for instructions on installing the protocol buffer compiler for your OS and language-specific plugins for Golang (NOTE: the Golang dependencies can also be installed via Homebrew.)
Step 2: Create Python Virtual Environment
You may create a Python virtual environment however you prefer, but the directory name .venv is ignored by Git for convenience, so you may choose to create your virtual environment in the root of the project.
> python -m venv .venv && . .venv/bin/activate
(.venv) >
Step 3: Upgrade pip and Install Build Dependencies
The following dependencies are required to build the client:
(.venv) > python -m pip install --upgrade pip
(.venv) > python -m pip install -r requirements.txt
Step 4: Compile API Protocol Buffers and Python Stub
The shell script gen_grpc.sh has been provided for convenience. Change the file access permissions to make it executable and run it:
(.venv) > chmod +x gen_grpc.sh
(.venv) > ./gen_grpc.sh
Step 5: Build Python Client and Dashboard
The shell script pip_update.sh has been provided for convenience. Change the file access permissions to make it executable and run it:
(.venv) > chmod +x pip_update.sh
(.venv) > ./pip_update.sh
Step 6: Optionally Run Client Test Suite
To ensure your changes haven’t broken the client, run the test suite with the following make target:
(.venv) > make pytest
Outcome
With steps 1-5 successfully completed, you should have the featureform CLI command accessible in your terminal session.
(.venv) > featureform -h
To further verify that your setup is complete and correct, you may optionally walk through the Quickstart tutorial. You may put the definitions.py file at the root of the project, which won’t be ignored by Git, or use a URL to a file (e.g. hosted on GitHub).
1 maintainer
Metadata
1 maintainer
Release files for featureform 1.15.8
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| featureform-1.15.8.tar.gz | 6.1 MB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| featureform-1.15.8-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 12.7 MB
Release files / featureform-1.15.8.tar.gz
| Download URL | featureform-1.15.8.tar.gz |
|---|---|
| Size | 6.1 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
abb2f475851dddaf1827e8d2fd021b1e366c8ec01189271a9a52ea40717abac8
|
|
BLAKE2b-256 checksum How to use checksums |
6f1dbba1bdb0b815decfbd90c01216230d4052bd7a3a0e9d8f3a718c9b7770c7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.3
|
Release files / featureform-1.15.8-py3-none-any.whl
| Download URL | featureform-1.15.8-py3-none-any.whl |
|---|---|
| Size | 6.6 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2436a0f2bd72ccd33028e9ae4ee89f0016d1e2cb4a4c95a0b72a1b4a9d9715b8
|
|
BLAKE2b-256 checksum How to use checksums |
b9ec6429bd2eab738e4e0eda149f1a42ef9102d88ee4db8e39dffe69c03b2199
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.3
|
