Skip to main content

Package for the Featureform Enterprise Feature Store

Project description

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.7-3.10 (Untested with version 3.11)

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).

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

featureform_enterprise-0.13.47.tar.gz (6.2 MB view details)

Uploaded Source

Built Distribution

featureform_enterprise-0.13.47-py3-none-any.whl (6.8 MB view details)

Uploaded Python 3

File details

Details for the file featureform_enterprise-0.13.47.tar.gz.

File metadata

File hashes

Hashes for featureform_enterprise-0.13.47.tar.gz
Algorithm Hash digest
SHA256 37dbe840c9af54a9c9dbb3b6362a488fc301bed49ab52e2302d827af85abe8e2
MD5 acdb97ceced365cb0f06c39991b25ac6
BLAKE2b-256 9c2dc8055d74f890f5780356840a6c51cdb724420e6b4c0702e021e29080b6f1

See more details on using hashes here.

File details

Details for the file featureform_enterprise-0.13.47-py3-none-any.whl.

File metadata

File hashes

Hashes for featureform_enterprise-0.13.47-py3-none-any.whl
Algorithm Hash digest
SHA256 0c131d034352eae6134d8d7d1df729353e0923be31c775c1a79b6f78ccb3cabe
MD5 f95671b6a7a2386ee63a4ea558f05356
BLAKE2b-256 c141f8587ed74ed52b033af4d79d12151ec8b284d76d7f83869dbaeb0da703a4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page