From 52ab65642f25fb1336df833c5218718f6f4f5235 Mon Sep 17 00:00:00 2001 From: Will Date: Sun, 28 Jul 2024 14:30:55 -0400 Subject: [PATCH] Fixing documentation and adding classifiers --- README.md | 6 +++--- pyproject.toml | 4 ++++ src/overturetoosm/__init__.py | 9 +++++---- src/overturetoosm/utils.py | 2 +- 4 files changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 554b162..0b37ede 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ ![PyPI - Version](https://img.shields.io/pypi/v/overturetoosm) ![Pepy Total Downlods](https://img.shields.io/pepy/dt/overturetoosm) -This Python project translates objects from the Overture maps schema to the OpenStreetMap (OSM) tagging scheme. The goal is to provide a seamless way to convert map data from Overture's format to a format that can be utilized within the OSM ecosystem. The package currently only supports Overture's `places` and `buildings` layers. You can improve the Overture categorization that this package uses by editing [the Overture categories page](https://wiki.openstreetmap.org/wiki/Overture_categories) on the OSM Wiki or submitting a pull request to the [tags.json](scripts/tags.json) file. +This Python project translates objects from the Overture maps schema to the OpenStreetMap (OSM) tagging scheme. The goal is to provide a seamless way to convert map data from Overture's format to a format that can be utilized within the OSM ecosystem. The package currently only supports Overture's `places` and `buildings` layers. You can improve the Overture categorization that this package uses by editing [the Overture categories page](https://wiki.openstreetmap.org/wiki/Overture_categories) on the OSM Wiki or submitting a pull request to the [tags.json](https://github.com/whubsch/overturetoosm/blob/main/scripts/tags.json) file. > [!NOTE] > Use of this package does not absolve you from following OSM's [import guidelines](https://wiki.openstreetmap.org/wiki/Import/Guidelines). @@ -20,7 +20,7 @@ This Python project translates objects from the Overture maps schema to the Open ## Features - Translate Overture map places to OSM tags. -- Handle various map object types, including roads, buildings, and points of interest. +- Handle various map object types, including buildings and points of interest. - Ensure compatibility with OSM data structures and conventions. ## Usage @@ -37,7 +37,7 @@ The documentation for our package is available online at our [documentation page ## License -This project is licensed under the MIT License. See the [LICENSE](LICENSE.txt) file for details. +This project is licensed under the MIT License. See the [LICENSE](https://github.com/whubsch/overturetoosm/blob/main/LICENSE.txt) file for details. ## See also diff --git a/pyproject.toml b/pyproject.toml index 5d0fec0..f7ed117 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -14,6 +14,7 @@ authors = [{ name = "Will", email = "wahubsch@gmail.com" }] classifiers = [ "Development Status :: 4 - Beta", "Programming Language :: Python", + "Programming Language :: Python :: 3 :: Only", "Programming Language :: Python :: 3.8", "Programming Language :: Python :: 3.9", "Programming Language :: Python :: 3.10", @@ -21,6 +22,9 @@ classifiers = [ "Programming Language :: Python :: 3.12", "Programming Language :: Python :: Implementation :: CPython", "Programming Language :: Python :: Implementation :: PyPy", + "Framework :: Hatch", + "License :: OSI Approved :: MIT License", + "Typing :: Typed", ] dependencies = ["pydantic"] diff --git a/src/overturetoosm/__init__.py b/src/overturetoosm/__init__.py index ecee8dc..8fce74d 100644 --- a/src/overturetoosm/__init__.py +++ b/src/overturetoosm/__init__.py @@ -1,11 +1,12 @@ """`overturetoosm` is a Python package to convert objects tagged in the Overture schema for use in OSM. Only Overture's `places` and `buildings` layers are currently supported. -""" -# SPDX-FileCopyrightText: 2024-present Will -# -# SPDX-License-Identifier: MIT +Links: +* [Project GitHub](https://github.com/whubsch/overturetoosm) +* [Documentation](https://whubsch.github.io/overturetoosm/) +* [PyPI](https://pypi.org/project/overturetoosm/) +""" from .places import process_place from .buildings import process_building diff --git a/src/overturetoosm/utils.py b/src/overturetoosm/utils.py index 4d85eb6..3d6dec1 100644 --- a/src/overturetoosm/utils.py +++ b/src/overturetoosm/utils.py @@ -20,7 +20,7 @@ def process_geojson( Example usage: ```python import json - from overturetoosm.places import process_geojson + from overturetoosm import process_geojson with open("overture.geojson", "r", encoding="utf-8") as f: contents: dict = json.load(f)