| Name | bro JSON |
| Version |
0.2.10
JSON |
| download |
| home_page | None |
| Summary | Open source python library for accessing BRO API |
| upload_time | 2024-04-03 06:29:27 |
| maintainer | None |
| docs_url | None |
| author | VIKTOR |
| requires_python | None |
| license | see LICENSE.txt |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
# BRO
This package can access the REST API from the [BRO](https://www.broloket.nl/ondergrondgegevens). Currently, this package provides
functionality to request CPTs from the BRO when you provide a region of interest. The format is based on the REST API of the BRO, which is described [here](https://publiek.broservices.nl/sr/cpt/v1/swagger-ui/#/default/) for CPTs.
Current options include retrieval of the following objects:
1. CPTs (format: bytes, dict)
The package also allows export of the retrieved data in GeoJSON format.
**Note 1**: The BRO is only available for the Netherlands, other locations are not supported.
**Note 2**: The API of the BRO is limited and requesting large amounts of data may result in instability.
## Installation
```python
pip install bro
```
## Use
Example usage to retrieve CPTs from the BRO as dictionaries.
```python
from datetime import datetime
import Envelope
import Point
import get_cpt_characteristics_and_return_cpt_objects
begin_date = datetime(2015, 1, 1).strftime("%Y-%m-%d")
end_date = datetime(2023, 3, 3).strftime("%Y-%m-%d")
# Define small square area that returns 5 valid cpts
lower_corner = Point(51.92269686635185, 4.469594207611851)
upper_corner = Point(51.923034432171065, 4.470094707426648)
area = Envelope(lower_corner, upper_corner)
cpts = get_cpt_characteristics_and_return_cpt_objects(begin_date, end_date, area, as_dict= True)
```
## LICENSE
```
MIT License
Copyright (c) 2023 VIKTOR
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
## Publish
- update changelog with version number
- update `bro/__version__.py`
- tag with version number
Raw data
{
"_id": null,
"home_page": null,
"name": "bro",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "VIKTOR",
"author_email": "support@viktor.ai",
"download_url": "https://files.pythonhosted.org/packages/3a/69/4f0020bcb0b4ab05390e377ba3957121d44081080347207ad5d45751214f/bro-0.2.10.tar.gz",
"platform": null,
"description": "\n\n# BRO\nThis package can access the REST API from the [BRO](https://www.broloket.nl/ondergrondgegevens). Currently, this package provides\nfunctionality to request CPTs from the BRO when you provide a region of interest. The format is based on the REST API of the BRO, which is described [here](https://publiek.broservices.nl/sr/cpt/v1/swagger-ui/#/default/) for CPTs.\n\nCurrent options include retrieval of the following objects: \n1. CPTs (format: bytes, dict)\n\nThe package also allows export of the retrieved data in GeoJSON format. \n\n**Note 1**: The BRO is only available for the Netherlands, other locations are not supported.\n\n**Note 2**: The API of the BRO is limited and requesting large amounts of data may result in instability.\n\n## Installation\n\n```python\npip install bro\n```\n\n## Use\nExample usage to retrieve CPTs from the BRO as dictionaries. \n```python\nfrom datetime import datetime\n\nimport Envelope\nimport Point\nimport get_cpt_characteristics_and_return_cpt_objects\n\nbegin_date = datetime(2015, 1, 1).strftime(\"%Y-%m-%d\")\nend_date = datetime(2023, 3, 3).strftime(\"%Y-%m-%d\")\n\n# Define small square area that returns 5 valid cpts\nlower_corner = Point(51.92269686635185, 4.469594207611851)\nupper_corner = Point(51.923034432171065, 4.470094707426648)\n\narea = Envelope(lower_corner, upper_corner)\ncpts = get_cpt_characteristics_and_return_cpt_objects(begin_date, end_date, area, as_dict= True)\n\n\n```\n\n## LICENSE\n\n```\nMIT License\n\nCopyright (c) 2023 VIKTOR\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n\n```\n\n## Publish\n- update changelog with version number\n- update `bro/__version__.py`\n- tag with version number\n",
"bugtrack_url": null,
"license": "see LICENSE.txt",
"summary": "Open source python library for accessing BRO API",
"version": "0.2.10",
"project_urls": {
"Example VIKTOR application": "https://demo.viktor.ai/public/bro-app",
"Source code": "https://github.com/viktor-platform/bro",
"Source code VIKTOR application": "https://github.com/viktor-platform/bro-app"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6077e523055f1f4ecf6f510c51da4cb80917743a0fbfe2044b6ed5174f4f09db",
"md5": "4bbb91a2c2582dd6b10e5220bef78b27",
"sha256": "d3dfb3a73f812a92eaeea0ded3bc857080ebab05e9d56a762f60b1bc48baeb5a"
},
"downloads": -1,
"filename": "bro-0.2.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4bbb91a2c2582dd6b10e5220bef78b27",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 9560,
"upload_time": "2024-04-03T06:29:25",
"upload_time_iso_8601": "2024-04-03T06:29:25.535486Z",
"url": "https://files.pythonhosted.org/packages/60/77/e523055f1f4ecf6f510c51da4cb80917743a0fbfe2044b6ed5174f4f09db/bro-0.2.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3a694f0020bcb0b4ab05390e377ba3957121d44081080347207ad5d45751214f",
"md5": "24869a4fb54314d717fac4fff57b0a7e",
"sha256": "1669ae568c5bede90a7d89a34862566ee3a841e09b9e306978c99fba4aa5dffc"
},
"downloads": -1,
"filename": "bro-0.2.10.tar.gz",
"has_sig": false,
"md5_digest": "24869a4fb54314d717fac4fff57b0a7e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 10845,
"upload_time": "2024-04-03T06:29:27",
"upload_time_iso_8601": "2024-04-03T06:29:27.212595Z",
"url": "https://files.pythonhosted.org/packages/3a/69/4f0020bcb0b4ab05390e377ba3957121d44081080347207ad5d45751214f/bro-0.2.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-03 06:29:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "viktor-platform",
"github_project": "bro",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "bro"
}
