# PyVelox: Python bindings and extensions for Velox
**This library is currently in Alpha stage and does not have a stable release. The API and implementation may change based on
user feedback or performance. Future changes may not be backward compatible.
If you have suggestions on the API or use cases you'd like to be covered, please open a
GitHub issue. We'd love to hear thoughts and feedback.**
## Prerequisites
You will need Python 3.7 or later. Also, we highly recommend installing an [Miniconda](https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-installer-links) environment.
First, set up an environment. If you are using conda, create a conda environment:
```
conda create --name pyveloxenv python=3.7
conda activate pyveloxenv
```
### Install PyVelox
You can install PyVelox from pypi without the need to build it from source as we provide wheels for Linux and macOS (x86_64):
```
pip install pyvelox
```
### From Source
You will need Python 3.7 or later and a C++17 compiler to build PyVelox from source.
#### Install Dependencies
On macOS
[HomeBrew](https://brew.sh/) is required to install development tools on macOS.
Run the script referenced [here](https://github.com/facebookincubator/velox#setting-up-on-macos) to install all the mac specific dependencies.
On Linux
Run the script referenced [here](https://github.com/facebookincubator/velox#setting-up-on-linux-ubuntu-2004-or-later) to install on linux.
#### Build PyVelox
For local development, you can build with debug mode:
```
make python-build
```
And run unit tests with
```
make python-test
```
Raw data
{
"_id": null,
"home_page": "https://github.com/facebookincubator/velox",
"name": "pyvelox",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "",
"author": "Meta",
"author_email": "velox@fb.com",
"download_url": "https://files.pythonhosted.org/packages/57/18/3853cd61841c9f4941b6df3407c82fd1f8e83e855b37d41ddfcb4b69e911/pyvelox-0.0.1a899.tar.gz",
"platform": null,
"description": "# PyVelox: Python bindings and extensions for Velox\n\n**This library is currently in Alpha stage and does not have a stable release. The API and implementation may change based on\nuser feedback or performance. Future changes may not be backward compatible.\nIf you have suggestions on the API or use cases you'd like to be covered, please open a\nGitHub issue. We'd love to hear thoughts and feedback.**\n\n\n## Prerequisites\n\nYou will need Python 3.7 or later. Also, we highly recommend installing an [Miniconda](https://docs.conda.io/en/latest/miniconda.html#latest-miniconda-installer-links) environment.\n\nFirst, set up an environment. If you are using conda, create a conda environment:\n```\nconda create --name pyveloxenv python=3.7\nconda activate pyveloxenv\n```\n\n### Install PyVelox\n\nYou can install PyVelox from pypi without the need to build it from source as we provide wheels for Linux and macOS (x86_64):\n```\npip install pyvelox\n```\n\n### From Source\n\nYou will need Python 3.7 or later and a C++17 compiler to build PyVelox from source.\n\n\n#### Install Dependencies\n\nOn macOS\n\n[HomeBrew](https://brew.sh/) is required to install development tools on macOS.\nRun the script referenced [here](https://github.com/facebookincubator/velox#setting-up-on-macos) to install all the mac specific dependencies.\n\nOn Linux\nRun the script referenced [here](https://github.com/facebookincubator/velox#setting-up-on-linux-ubuntu-2004-or-later) to install on linux.\n\n\n#### Build PyVelox\n\nFor local development, you can build with debug mode:\n```\nmake python-build\n```\n\nAnd run unit tests with\n```\nmake python-test\n```\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Python bindings and extensions for Velox",
"version": "0.0.1a899",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7b6acc54d5a15d7b553c990344937e11f194ce32c7c11d3207ad76e6caacd20d",
"md5": "7c8d700be3c56f164513aa9d89319bf9",
"sha256": "fdde7f6d9cdb72abc938455587a30b918ef76be443b56cef39ef86a0869ec91e"
},
"downloads": -1,
"filename": "pyvelox-0.0.1a899-cp310-cp310-macosx_10_15_x86_64.whl",
"has_sig": false,
"md5_digest": "7c8d700be3c56f164513aa9d89319bf9",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.7",
"size": 30514751,
"upload_time": "2023-04-13T23:26:09",
"upload_time_iso_8601": "2023-04-13T23:26:09.948920Z",
"url": "https://files.pythonhosted.org/packages/7b/6a/cc54d5a15d7b553c990344937e11f194ce32c7c11d3207ad76e6caacd20d/pyvelox-0.0.1a899-cp310-cp310-macosx_10_15_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e1c525dd0189e77958c8127c158fc7090426015f86e88f4e676a67dc6f89474a",
"md5": "8ca0bfd39b0d13492113b76b8b3f53fb",
"sha256": "b1fa856cf43fcd16772b035087a604eef04e2321f572176ece9998980b05a512"
},
"downloads": -1,
"filename": "pyvelox-0.0.1a899-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "8ca0bfd39b0d13492113b76b8b3f53fb",
"packagetype": "bdist_wheel",
"python_version": "cp310",
"requires_python": ">=3.7",
"size": 27823289,
"upload_time": "2023-04-13T23:26:13",
"upload_time_iso_8601": "2023-04-13T23:26:13.551082Z",
"url": "https://files.pythonhosted.org/packages/e1/c5/25dd0189e77958c8127c158fc7090426015f86e88f4e676a67dc6f89474a/pyvelox-0.0.1a899-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "18a7ff19f57fa1063bfb2405adeda593944f98cecb43c0951d5f61b7d16ab4de",
"md5": "0dc45b0b267a17be5dbe79930a87f023",
"sha256": "55b7d2af07a35a2b3b244e894c442ca2d3131ae1bcfff39b3b2289309177a9e2"
},
"downloads": -1,
"filename": "pyvelox-0.0.1a899-cp311-cp311-macosx_10_15_x86_64.whl",
"has_sig": false,
"md5_digest": "0dc45b0b267a17be5dbe79930a87f023",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.7",
"size": 30515090,
"upload_time": "2023-04-13T23:26:17",
"upload_time_iso_8601": "2023-04-13T23:26:17.038854Z",
"url": "https://files.pythonhosted.org/packages/18/a7/ff19f57fa1063bfb2405adeda593944f98cecb43c0951d5f61b7d16ab4de/pyvelox-0.0.1a899-cp311-cp311-macosx_10_15_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "82f5b6066fc69a16fc4aec97d62bfdf6bf88a707e7ca67ec6444d9dbdee8ce2a",
"md5": "22f3b81eaa5b47893ca6d965287e8af7",
"sha256": "afeb21801f46ac5046e239cd074ed845dafea6af9d301a04b434ecf9c5b4e6d4"
},
"downloads": -1,
"filename": "pyvelox-0.0.1a899-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "22f3b81eaa5b47893ca6d965287e8af7",
"packagetype": "bdist_wheel",
"python_version": "cp311",
"requires_python": ">=3.7",
"size": 27823261,
"upload_time": "2023-04-13T23:26:20",
"upload_time_iso_8601": "2023-04-13T23:26:20.164348Z",
"url": "https://files.pythonhosted.org/packages/82/f5/b6066fc69a16fc4aec97d62bfdf6bf88a707e7ca67ec6444d9dbdee8ce2a/pyvelox-0.0.1a899-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "048fe25929758ccfe9f36b9962d630f2d4328e2c23ee993ab97369985b28c3cf",
"md5": "df7caa4d609a5020e47efe1583b5637e",
"sha256": "9684460e9e678746d79af322647c3b9bccc9fd71b09669d64e070615575f0dc7"
},
"downloads": -1,
"filename": "pyvelox-0.0.1a899-cp37-cp37m-macosx_10_15_x86_64.whl",
"has_sig": false,
"md5_digest": "df7caa4d609a5020e47efe1583b5637e",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7",
"size": 30510737,
"upload_time": "2023-04-13T23:26:22",
"upload_time_iso_8601": "2023-04-13T23:26:22.987234Z",
"url": "https://files.pythonhosted.org/packages/04/8f/e25929758ccfe9f36b9962d630f2d4328e2c23ee993ab97369985b28c3cf/pyvelox-0.0.1a899-cp37-cp37m-macosx_10_15_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f0516a60ff67500e210e94f7db5eb06a2f0b41e5527d7042cdc8c14ea75d4b81",
"md5": "cb582a5cd6c72eb7a161aa20e59d0b01",
"sha256": "4ee12692b533d95ee9afaff79ee83529527475a2019a425f039587dd0fae972e"
},
"downloads": -1,
"filename": "pyvelox-0.0.1a899-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "cb582a5cd6c72eb7a161aa20e59d0b01",
"packagetype": "bdist_wheel",
"python_version": "cp37",
"requires_python": ">=3.7",
"size": 27827677,
"upload_time": "2023-04-13T23:26:25",
"upload_time_iso_8601": "2023-04-13T23:26:25.710586Z",
"url": "https://files.pythonhosted.org/packages/f0/51/6a60ff67500e210e94f7db5eb06a2f0b41e5527d7042cdc8c14ea75d4b81/pyvelox-0.0.1a899-cp37-cp37m-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1708c1784e5d1499b07a6b261303b71d26da7b555c0beaac9ea759c4925144b2",
"md5": "d18334339ec6ded2aa1061ef1983cf75",
"sha256": "9d3f495dc36ec1fc0a158a7486cfd0364fbb3a40bd7a26a05de84e3179055569"
},
"downloads": -1,
"filename": "pyvelox-0.0.1a899-cp38-cp38-macosx_10_15_x86_64.whl",
"has_sig": false,
"md5_digest": "d18334339ec6ded2aa1061ef1983cf75",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.7",
"size": 30514948,
"upload_time": "2023-04-13T23:26:29",
"upload_time_iso_8601": "2023-04-13T23:26:29.027976Z",
"url": "https://files.pythonhosted.org/packages/17/08/c1784e5d1499b07a6b261303b71d26da7b555c0beaac9ea759c4925144b2/pyvelox-0.0.1a899-cp38-cp38-macosx_10_15_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "c26eb7ffd2d33007a714eaf3361a5e544535413ec3b66fb9ae8f200b2e135313",
"md5": "5614b5b18134858699f6e76ce06908c5",
"sha256": "451f0799a02817ca7e0c70e75001a285dbdb8951c25582642c4ffb137f8de715"
},
"downloads": -1,
"filename": "pyvelox-0.0.1a899-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "5614b5b18134858699f6e76ce06908c5",
"packagetype": "bdist_wheel",
"python_version": "cp38",
"requires_python": ">=3.7",
"size": 27823264,
"upload_time": "2023-04-13T23:26:33",
"upload_time_iso_8601": "2023-04-13T23:26:33.422255Z",
"url": "https://files.pythonhosted.org/packages/c2/6e/b7ffd2d33007a714eaf3361a5e544535413ec3b66fb9ae8f200b2e135313/pyvelox-0.0.1a899-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0d991efb423e48d786a0be4991e69bb2dc3bd785275f5c5fc11e00c29afa6728",
"md5": "3f1eaf2d50d1fd82207e688eb8a41f8d",
"sha256": "e27f861b31525cedd9d382693ab0eeafdcd47c73b106d391297f398d1f660708"
},
"downloads": -1,
"filename": "pyvelox-0.0.1a899-cp39-cp39-macosx_10_15_x86_64.whl",
"has_sig": false,
"md5_digest": "3f1eaf2d50d1fd82207e688eb8a41f8d",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.7",
"size": 30515265,
"upload_time": "2023-04-13T23:26:36",
"upload_time_iso_8601": "2023-04-13T23:26:36.932295Z",
"url": "https://files.pythonhosted.org/packages/0d/99/1efb423e48d786a0be4991e69bb2dc3bd785275f5c5fc11e00c29afa6728/pyvelox-0.0.1a899-cp39-cp39-macosx_10_15_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7ce98c8c7e1b81c650f9acb6aaec8f04176296db0d2c15dbba3227ba337bd536",
"md5": "c1a87613f4b8094b413a4b1fbe368101",
"sha256": "5f8db5aeedcf1f367be90f931c1cb0b63e8d3ec66025b3dfc489d4c6b7f227eb"
},
"downloads": -1,
"filename": "pyvelox-0.0.1a899-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "c1a87613f4b8094b413a4b1fbe368101",
"packagetype": "bdist_wheel",
"python_version": "cp39",
"requires_python": ">=3.7",
"size": 27823919,
"upload_time": "2023-04-13T23:26:40",
"upload_time_iso_8601": "2023-04-13T23:26:40.121740Z",
"url": "https://files.pythonhosted.org/packages/7c/e9/8c8c7e1b81c650f9acb6aaec8f04176296db0d2c15dbba3227ba337bd536/pyvelox-0.0.1a899-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "57183853cd61841c9f4941b6df3407c82fd1f8e83e855b37d41ddfcb4b69e911",
"md5": "af0c4271e4fadca2a05498af3022cc89",
"sha256": "5d4fca5e9f9c8c8a236c42e48d9a8570b8e8e3a199f13ff61cc57f9c30d5e12a"
},
"downloads": -1,
"filename": "pyvelox-0.0.1a899.tar.gz",
"has_sig": false,
"md5_digest": "af0c4271e4fadca2a05498af3022cc89",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 9138509,
"upload_time": "2023-04-13T23:26:42",
"upload_time_iso_8601": "2023-04-13T23:26:42.799092Z",
"url": "https://files.pythonhosted.org/packages/57/18/3853cd61841c9f4941b6df3407c82fd1f8e83e855b37d41ddfcb4b69e911/pyvelox-0.0.1a899.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-13 23:26:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "facebookincubator",
"github_project": "velox",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"circle": true,
"lcname": "pyvelox"
}
JSON
