Skip to main content

python client for the Roboflow application

Project description

Roboflow Python Library

roboflow logo


Roboflow makes managing, preprocessing, augmenting, and versioning datasets for computer vision seamless. This is the official Roboflow python package that interfaces with the Roboflow API. Key features of Roboflow:


To install this package, please use Python 3.6 or higher. We provide three different ways to install the Roboflow package to use within your own projects.

Install from PyPi (Recommended):

pip install roboflow

Install from Source:

git clone
cd roboflow-python
python3 -m venv env
source env/bin/activate 
pip3 install -r requirements.txt


import roboflow

# Instantiate Roboflow object with your API key
rf = roboflow.Roboflow(api_key=YOUR_API_KEY_HERE)

# List all projects for your workspace
workspace = rf.workspace()

# Load a certain project, workspace url is optional
project = rf.project("PROJECT_ID")

# List all versions of a specific project

# Upload image to dataset

# Retrieve the model of a specific project

# predict on a local image
prediction = model.predict("YOUR_IMAGE.jpg")

# Predict on a hosted image
prediction = model.predict("YOUR_IMAGE.jpg", hosted=True)

# Plot the prediction

# Convert predictions to JSON

# Save the prediction as an image'predictions.jpg')

Using this package for a specifc project

If you have a specific project from your workspace you'd like to run in a notebook follow along on this tutorial Downloading Datasets from Roboflow for Training (Python)

Selecting the format you'd like your project to be exported as while choosing the show download code option will display code snippets you can use in either Jupyter or your terminal. These code snippets will include your api_key, project, and workspace names.

Alt Text

Devving locally

  1. clone repo
  2. create a virtual env: virtualenv local_dev
  3. activate virtual env: source local_dev/bin/activate
  4. install packages from repo: pip3 install -r requirements.txt
  5. create script on top level of ROBOFLOW-PYTHON and reference local roboflow directory: from roboflow import Roboflow
  6. when done, uptick the pip package minor version number in
  7. manually add any new dependencies to the requirements.txt and list of dependencies in (careful not to overwrite any packages that might screw up backwards dependencies for object detection, etc.)

Project details

Release history Release notifications | RSS feed

This version


Download files

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

Source Distribution

roboflow-0.2.5.tar.gz (17.6 kB view hashes)

Uploaded Source

Built Distribution

roboflow-0.2.5-py2-none-any.whl (28.1 kB view hashes)

Uploaded Python 2

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