Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

Osquery Python API

Project Description

.. image::

`osquery <>`_ exposes an operating system as
a high-performance relational database. This allows you to write SQL-based
queries to explore operating system data. With osquery, SQL tables represent
abstract concepts such as running processes, loaded kernel modules, open
network connections, browser plugins, hardware events or file hashes.

If you're interested in learning more about osquery, visit the `GitHub project
<>`_, the `website <>`_, and
the `users guide <>`_.

What is osquery-python?

.. image::

In osquery, SQL tables, configuration retrieval, log handling, etc are implemented
via a simple, robust plugin and extensions API. This project contains the official
Python bindings for creating osquery extensions in Python. Consider the following

.. code-block:: python

#!/usr/bin/env python

import osquery

class MyTablePlugin(osquery.TablePlugin):
def name(self):
return "foobar"

def columns(self):
return [
osquery.TableColumn(name="foo", type=osquery.STRING),
osquery.TableColumn(name="baz", type=osquery.STRING),

def generate(self, context):
query_data = []

for _ in range(2):
row = {}
row["foo"] = "bar"
row["baz"] = "baz"

return query_data

if __name__ == "__main__":

To test this code start an osquery shell:

.. code-block:: none

osqueryi --nodisable_extensions
osquery> select value from osquery_flags where name = 'extensions_socket';
| value |
| /Users/USERNAME/.osquery/shell.em |

Then start the Python extension:

.. code-block:: none

python ./ --socket /Users/USERNAME/.osquery/shell.em

Alternatively, you can also autoload your extension when starting an osquery shell:

.. code-block:: none

osqueryi --extension

This will register a table called "foobar". As you can see, the table will
return two rows:

.. code-block:: none

osquery> select * from foobar;
| foo | baz |
| bar | baz |
| bar | baz |

This is obviously a contrived example, but it's easy to imagine the

Using the instructions found on the `wiki
you can easily deploy your extension with an existing osquery deployment.

Extensions are the core way that you can extend and customize osquery. At
Facebook, we use extensions extensively to implement many plugins that take
advantage of internal APIs and tools.

Execute queries in Python

The same Thrift bindings can be used to create a Python client for the osqueryd or
osqueryi's extension socket. There are helper classes provided that spawn an ephemeral
osquery process for consecutive or long running client instances.

.. code-block:: python

import osquery

if __name__ == "__main__":
# Spawn an osquery process using an ephemeral extension socket.
instance = osquery.SpawnInstance()

# Issues queries and call osquery Thrift APIs.
instance.client.query("select timestamp from time")


This module is currently in "beta mode". We're testing the API and UX before
uploading the module to PyPI.

To install, clone this repo and run the following:

.. code-block:: none

python build
python install

Alternatively, if you don't want to clone the repo, you can simply:

.. code-block:: none

pip install git+git://

See ` <>`_
and the `osquery wiki <>`_ for development information.


Facebook has a `bug bounty <>`_ program that
includes osquery. If you find a security vulnerability in osquery, please
submit it via the process outlined on that page and do not file a public issue.
For more information on finding vulnerabilities in osquery, see a recent blog
post about `bug-hunting osquery
Release History

Release History

This version
History Node


History Node


History Node


History Node


Download Files

Download Files

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

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
osquery-2.2.1.tar.gz (16.7 kB) Copy SHA256 Checksum SHA256 Source May 29, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting