# GeoPortal Plugin for OneCode
This plugin wraps OneCode input and output elements so that they work seamlessly with the GeoPortal.
Compatible with OneCode 1.0.0+ only.
## CLI
To produce `interface.json` as well as `i18n` files, run from the root OneCode project:
```bash
geoportal-extract
```
## API
**Inputs**
Use `geo_` prefix in front of all OneCode elements, e.g. `geo_slider` instead of `slider`, etc.
**Outputs**
```python
geo_file_output(
path: str, # Path to the output file
type: str, # GeoPortal type, e.g. CSV, BlockModel, etc.
prefix: str = "", # Optional prefix to left-strip file path
group: bool = False, # True for GeoPortal multi-files (e.g. ShpFile)
release: bool = False, # True to record file as a release for the sign-off process
key: str = None, # Specific key in case file is reference in another workflow
**kwargs # Any additional properties to attach to the GeoPortal file
)
```
## Examples
Checkout the examples folders.
Raw data
{
"_id": null,
"home_page": "https://github.com/deeplime-io/geoportal",
"name": "geoportal",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "onecode, plugin, geoportal",
"author": "DeepLime",
"author_email": "contact@deeplime.io",
"download_url": "https://files.pythonhosted.org/packages/60/1b/6b49cb40b462f4b73d4772935cb94899231e9c82cce0f7aefaf8154f85b7/geoportal-1.0.0.tar.gz",
"platform": null,
"description": "# GeoPortal Plugin for OneCode\n\nThis plugin wraps OneCode input and output elements so that they work seamlessly with the GeoPortal.\nCompatible with OneCode 1.0.0+ only.\n\n## CLI\n\nTo produce `interface.json` as well as `i18n` files, run from the root OneCode project:\n\n```bash\ngeoportal-extract\n```\n\n## API\n\n**Inputs**\nUse `geo_` prefix in front of all OneCode elements, e.g. `geo_slider` instead of `slider`, etc.\n\n**Outputs**\n\n```python\ngeo_file_output(\n path: str, # Path to the output file\n type: str, # GeoPortal type, e.g. CSV, BlockModel, etc.\n prefix: str = \"\", # Optional prefix to left-strip file path\n group: bool = False, # True for GeoPortal multi-files (e.g. ShpFile)\n release: bool = False, # True to record file as a release for the sign-off process\n key: str = None, # Specific key in case file is reference in another workflow\n **kwargs # Any additional properties to attach to the GeoPortal file\n)\n```\n\n## Examples\n\nCheckout the examples folders.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "GeoPortal plugin for OneCode",
"version": "1.0.0",
"project_urls": {
"Documentation": "https://deeplime-io.github.io/geoportal",
"Homepage": "https://github.com/deeplime-io/geoportal",
"Repository": "https://github.com/deeplime-io/geoportal"
},
"split_keywords": [
"onecode",
" plugin",
" geoportal"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "95692acb6276921f0d530e7b5b730755e1193fb9eaade5dd2380734a24fab206",
"md5": "06af35a987c6d0863a2c904151402325",
"sha256": "9e1d72844963d05402e8267ed03b85b224afefbd81070a2282cc90b729cd84dd"
},
"downloads": -1,
"filename": "geoportal-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "06af35a987c6d0863a2c904151402325",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 11722,
"upload_time": "2024-12-10T09:04:27",
"upload_time_iso_8601": "2024-12-10T09:04:27.839045Z",
"url": "https://files.pythonhosted.org/packages/95/69/2acb6276921f0d530e7b5b730755e1193fb9eaade5dd2380734a24fab206/geoportal-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "601b6b49cb40b462f4b73d4772935cb94899231e9c82cce0f7aefaf8154f85b7",
"md5": "a5c159318f39afb2fa27716d6b1ab8f5",
"sha256": "8479d1baf2fae0b5c8ac5545556d7b3ef66088a67070d5754ba7f0686db35af0"
},
"downloads": -1,
"filename": "geoportal-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "a5c159318f39afb2fa27716d6b1ab8f5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 6636,
"upload_time": "2024-12-10T09:04:31",
"upload_time_iso_8601": "2024-12-10T09:04:31.154639Z",
"url": "https://files.pythonhosted.org/packages/60/1b/6b49cb40b462f4b73d4772935cb94899231e9c82cce0f7aefaf8154f85b7/geoportal-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-10 09:04:31",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "deeplime-io",
"github_project": "geoportal",
"github_not_found": true,
"lcname": "geoportal"
}
JSON
