Package: odp-stockholm
Asynchronous Python client for the open datasets of Stockholm (Sweden).AboutA python package with which you can retrieve data from the Open Data Platform of Stockholm viatheir API. This package was initially created to only retrieve parking data from the API, but the code base is made in such a way that it is easy to extend for other datasets from the same platform.Installationpipinstallodp-stockholmDatasetsYou can read the following datasets with this package:Disabled parkings / rörelsehindrade förare med särskilt tillståndTo use the data you need an API key, which you can request viathis link.Click here to get more detailsDisabled parkings (2045 locations)You can use the following parameters in your request:limit(default: 10) - How many results you want to retrieve.VariableTypeDescriptionlocation_idstringThe id of the locationlocation_typestringThe type of the locationnumberintegerHow many parking spots there are on this locationstreetstringThe street name of the locationaddressstringThe address of the locationdistrictstringThe district name where the location isparking_ratestringThe parking rate of the locationparking_rulesstringURL to the parking regulations of Stockholmvalid_fromdatetimeThe date from when the parking is validvalid_todatetime (or None)The date until when the parking is validcoordinateslist[float]The coordinates of the locationExampleimportasynciofromodp_stockholmimportParkingStockholmasyncdefmain()->None:"""Show example on using this package."""asyncwithParkingStockholm(api_key="YOUR_API_KEY")asclient:locations=awaitclient.disabled_parkings(limit=10,)print(locations)if__name__=="__main__":asyncio.run(main())ContributingThis is an active open-source project. We are always open to people who want to
use the code or contribute to it.We've set up a separate document for ourcontribution guidelines.Thank you for being involved! :heart_eyes:Setting up development environmentThe simplest way to begin is by utilizing theDev Containerfeature of Visual Studio Code or by opening a CodeSpace directly on GitHub.
By clicking the button below you immediately start a Dev Container in Visual Studio Code.This Python project relies onPoetryas its dependency manager,
providing comprehensive management and control over project dependencies.You need at least:Python 3.11+PoetryInstall all packages, including all development requirements:poetryinstallPoetry creates by default an virtual environment where it installs all
necessary pip packages, to enter or exit the venv run the following commands:poetryshellexitSetup the pre-commit check, you must run this inside the virtual environment:pre-commitinstallNow you're all set to get started!As this repository uses thepre-commitframework, all changes
are linted and tested with each commit. You can run all checks and tests
manually, using the following command:poetryrunpre-commitrun--all-filesTo run just the Python tests:poetryrunpytestLicenseMIT LicenseCopyright (c) 2023 Klaas SchoutePermission 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.