# Deephaven Plugin Utilities
This is a Python package that stores cross-plugin utilities for building Deephaven plugins.
If the functions are only used during the build process, they should be added to `packaging` instead.
This is not a plugin on its own.
## Build
To create your build / development environment (skip the first two lines if you already have a venv):
```sh
python -m venv .venv
source .venv/bin/activate
pip install --upgrade pip setuptools
pip install build deephaven-plugin
```
To build:
```sh
python -m build --wheel
```
The wheel is stored in `dist/`.
To test within [deephaven-core](https://github.com/deephaven/deephaven-core), note where this wheel is stored (using `pwd`, for example).
Then, follow the directions in the top-level README.md to install the wheel into your Deephaven environment.
Raw data
{
"_id": null,
"home_page": "https://github.com/deephaven/deephaven-plugins",
"name": "deephaven-plugin-utilities",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "deephaven,plugin,utilities",
"author": "Joe Numainville",
"author_email": "josephnumainville@deephaven.io",
"download_url": "",
"platform": "any",
"description": "# Deephaven Plugin Utilities\n\nThis is a Python package that stores cross-plugin utilities for building Deephaven plugins.\nIf the functions are only used during the build process, they should be added to `packaging` instead.\nThis is not a plugin on its own.\n\n## Build\n\nTo create your build / development environment (skip the first two lines if you already have a venv):\n\n```sh\npython -m venv .venv\nsource .venv/bin/activate\npip install --upgrade pip setuptools\npip install build deephaven-plugin\n```\n\nTo build:\n\n```sh\npython -m build --wheel\n```\n\nThe wheel is stored in `dist/`.\n\nTo test within [deephaven-core](https://github.com/deephaven/deephaven-core), note where this wheel is stored (using `pwd`, for example).\nThen, follow the directions in the top-level README.md to install the wheel into your Deephaven environment.\n",
"bugtrack_url": null,
"license": "",
"summary": "Deephaven Plugin Utilities",
"version": "0.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/deephaven/deephaven-plugins/issues",
"Homepage": "https://github.com/deephaven/deephaven-plugins",
"Source Code": "https://github.com/deephaven/deephaven-plugins"
},
"split_keywords": [
"deephaven",
"plugin",
"utilities"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e3cf1f0fd4d1694aa9a79703dcafaa30aa9184f8548cf09c5ddbe6c3a7dc817b",
"md5": "7d725e798c48f4b01b86f90cea3568c4",
"sha256": "524e90d3f795609ccbd5cb9fd2e768b760f38a32946fa009eb02fceee917bd69"
},
"downloads": -1,
"filename": "deephaven_plugin_utilities-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7d725e798c48f4b01b86f90cea3568c4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8229,
"upload_time": "2024-03-06T19:39:34",
"upload_time_iso_8601": "2024-03-06T19:39:34.912357Z",
"url": "https://files.pythonhosted.org/packages/e3/cf/1f0fd4d1694aa9a79703dcafaa30aa9184f8548cf09c5ddbe6c3a7dc817b/deephaven_plugin_utilities-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-06 19:39:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "deephaven",
"github_project": "deephaven-plugins",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "deephaven-plugin-utilities"
}
JSON
