Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 1.64 KB

README.md

File metadata and controls

51 lines (33 loc) · 1.64 KB
Raw

This is the DuckDB Python package

Default installation

You would normally install the DuckDB released version using pip as follows: pip install duckdb

Installing locally

For development, you may need a DuckDB python package that is installed from source. Proceed as follows.

Set the prefix path:

export DUCKDB_PREFIX=/path/to/install/duckdb

Set the PYTHONPATH to the site-packages directory under the prefix path; this will usually work but do check the resulting PYTHONPATH.

export PYTHONPATH=${PYTHONPATH:+${PYTHONPATH}:}$(pip show six | \
  grep "Location:" | cut -d " " -f2 | \
  sed -e "s|/usr|${DUCKDB_PREFIX}|")

Setup for development

Install the package from the root of the DuckDB reposity:

cd ../..
pip3 install --prefix $DUCKDB_PREFIX -e tools/pythonpkg

This creates a package that uses the files in tools/pythonpkg, the best option during development.

Setup for cloud storage

Alternatively, you may need the package files to reside under the same prefix where the library is installed; e.g., when installing to cloud storage from a notebook.

First, get the repository based version number and extract the source distribution.

cd tools/pythonpkg
export SETUPTOOLS_SCM_PRETEND_VERSION=$(python setup.py --version)
python setup.py sdist
cd ../..

Next, copy over the python package related files, and install the package.

mkdir -p $DUCKDB_PREFIX/src/duckdb-pythonpkg
tar --directory=$DUCKDB_PREFIX/src/duckdb-pythonpkg -xzpf tools/pythonpkg/dist/duckdb-${SETUPTOOLS_SCM_PRETEND_VERSION}.tar.gz
pip3 install --prefix $DUCKDB_PREFIX -e $DUCKDB_PREFIX/src/duckdb-pythonpkg