# vjmap-py-client
Python Client for VjMap REST services
## Installation
Install with pip:
```bash
pip install vjmap-py-client
```
## Usage
```python
from vjmap_py_client import VjmapClient, RectQueryParameter, PointQueryParameter, ExprQueryParameter, ConditionQueryParameter
client = VjmapClient(access_token="your_access_token", base_url="your_base_url")
# Upload a map
upload_result = client.upload_map(map_file_path="your_map_file_path")
map_id = upload_result["mapid"]
fileid = upload_result["fileid"]
uploadname = upload_result["uploadname"]
# Open a map
result = client.open_map(map_id=map_id,
params={"fileid": fileid, "uploadname": uploadname})
version = result["version"]
# List all maps
result = client.list_maps(map_id=map_id, version=version)
# Get bounds
result = client.get_data_bounds(map_id=map_id, version=version)
x1, y1, x2, y2 = result["bounds"]
# Query a map
rect = RectQueryParameter(x1=x1, y1=y1, x2=x2, y2=y2)
# you can also use PointQueryParameter or ExprQueryParameter or ConditionQueryParameter
result = client.query_features(map_id=map_id, version=version, parameters=rect)
# Get metadata
result = client.get_metadata(map_id=map_id, version=version)
# Close a map
result = client.close_map(map_id=map_id, version=version)
```
Raw data
{
"_id": null,
"home_page": "https://github.com/twisker/vjmap-py-client",
"name": "vjmap-py-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": null,
"keywords": "vjmap cad python sdk client",
"author": "Neo Wang",
"author_email": "wang.neo@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/87/9a/7f750074e879eb7bd18bb1f1a10cab072529d09460167caa2f412b3d7859/vjmap_py_client-0.1.4.tar.gz",
"platform": null,
"description": "# vjmap-py-client\n\nPython Client for VjMap REST services\n\n## Installation\n\nInstall with pip:\n\n```bash\npip install vjmap-py-client\n```\n\n## Usage\n\n```python\nfrom vjmap_py_client import VjmapClient, RectQueryParameter, PointQueryParameter, ExprQueryParameter, ConditionQueryParameter\n\nclient = VjmapClient(access_token=\"your_access_token\", base_url=\"your_base_url\")\n\n# Upload a map\nupload_result = client.upload_map(map_file_path=\"your_map_file_path\")\nmap_id = upload_result[\"mapid\"]\nfileid = upload_result[\"fileid\"]\nuploadname = upload_result[\"uploadname\"]\n\n# Open a map\nresult = client.open_map(map_id=map_id,\n params={\"fileid\": fileid, \"uploadname\": uploadname})\nversion = result[\"version\"]\n\n# List all maps\nresult = client.list_maps(map_id=map_id, version=version)\n\n# Get bounds\nresult = client.get_data_bounds(map_id=map_id, version=version)\nx1, y1, x2, y2 = result[\"bounds\"]\n\n# Query a map\nrect = RectQueryParameter(x1=x1, y1=y1, x2=x2, y2=y2)\n# you can also use PointQueryParameter or ExprQueryParameter or ConditionQueryParameter\nresult = client.query_features(map_id=map_id, version=version, parameters=rect)\n\n# Get metadata\nresult = client.get_metadata(map_id=map_id, version=version)\n\n# Close a map\nresult = client.close_map(map_id=map_id, version=version)\n\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A package for interacting with the Vjmap Service-API",
"version": "0.1.4",
"project_urls": {
"Homepage": "https://github.com/twisker/vjmap-py-client"
},
"split_keywords": [
"vjmap",
"cad",
"python",
"sdk",
"client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "28b6fd9f47541948142d223f9aaf7b4b57dc40c595ca09969bb702ad3cf18364",
"md5": "869286de969434bb5e07add1565edb39",
"sha256": "3fdab3edc2e2efd0155a3aa20defcd41598e546bae2e42ecebebcf3f34b8a424"
},
"downloads": -1,
"filename": "vjmap_py_client-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "869286de969434bb5e07add1565edb39",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 6822,
"upload_time": "2024-11-20T15:13:18",
"upload_time_iso_8601": "2024-11-20T15:13:18.158611Z",
"url": "https://files.pythonhosted.org/packages/28/b6/fd9f47541948142d223f9aaf7b4b57dc40c595ca09969bb702ad3cf18364/vjmap_py_client-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "879a7f750074e879eb7bd18bb1f1a10cab072529d09460167caa2f412b3d7859",
"md5": "871efbec151f390f7e52b05c7a50a196",
"sha256": "bfe821b7cf675d41eaed1e3cd514008b52d62f82bddd0eed75640e4f5fe5ad26"
},
"downloads": -1,
"filename": "vjmap_py_client-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "871efbec151f390f7e52b05c7a50a196",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 6772,
"upload_time": "2024-11-20T15:13:19",
"upload_time_iso_8601": "2024-11-20T15:13:19.599965Z",
"url": "https://files.pythonhosted.org/packages/87/9a/7f750074e879eb7bd18bb1f1a10cab072529d09460167caa2f412b3d7859/vjmap_py_client-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-20 15:13:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "twisker",
"github_project": "vjmap-py-client",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "vjmap-py-client"
}
JSON
