Skip to content

Commit

Permalink
rename app/repo to coordinate-transformation-api
Browse files Browse the repository at this point in the history
  • Loading branch information
arbakker committed Nov 30, 2023
1 parent 2faea03 commit f7897ec
Show file tree
Hide file tree
Showing 28 changed files with 46 additions and 306 deletions.
2 changes: 1 addition & 1 deletion .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"args": [
"--reload",
"--port", "8000",
"coordinates_transformation_api.main:app",
"coordinate_transformation_api.main:app",
],
"env": {
"LOG_LEVEL": "DEBUG",
Expand Down
260 changes: 0 additions & 260 deletions EXAMPLE_REQUESTS.md

This file was deleted.

10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Coordinates transformation API
# Coordinate Transformation API

RESTful coordinates transformation API offering NSGI approved transformations
RESTful Coordinate Transformation API offering NSGI approved transformations
for the Netherlands. Build on top of pyproj and FastAPI.

## Assumptions
Expand Down Expand Up @@ -79,7 +79,7 @@ mypy --install-types
Check test coverage (install `coverage` with `pip install coverage`):

```sh
coverage run --source=src/coordinates_transformation_api -m pytest -v tests && coverage report -m
coverage run --source=src/coordinate_transformation_api -m pytest -v tests && coverage report -m
```

## Install
Expand All @@ -99,13 +99,13 @@ ct-api
### Build container

```bash
docker build -t nsgi/coordinatestransformation-api .
docker build -t nsgi/coordinate-transformation-api .
```

### Run container

```bash
docker run --rm -d -p 8000:8000 --name ct-api nsgi/coordinatestransformation-api
docker run --rm -d -p 8000:8000 --name ct-api nsgi/coordinate-transformation-api
```

## CityJSON
Expand Down
18 changes: 9 additions & 9 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "coordinates-transformation-api"
description = "Coordinates transformation API of the Nederlandse Samenwerking Geodetische Infrastructuur (NSGI)"
name = "coordinate-transformation-api"
description = "Coordinate Transformation API of the Nederlandse Samenwerking Geodetische Infrastructuur (NSGI)"
keywords = ["NSGI", "pyproj", "fastapi", "coordinates", "geo"]
license = { text = "MIT" }
classifiers = [
Expand All @@ -17,7 +17,7 @@ dependencies = [
"pyproj == 3.6.0",
"pydantic-settings == 2.0.2",
"email-validator == 2.0.0",
"geodense ~= 0.0.1a4",
"geodense ~= 0.0.1a5",
]
requires-python = ">=3.11.4"
dynamic = ["version"]
Expand All @@ -37,20 +37,20 @@ requires = ["setuptools>=61.0", "setuptools-git-versioning<2"]
build-backend = "setuptools.build_meta"

[project.scripts]
ct-api = "coordinates_transformation_api.main:main"
ct-api = "coordinate_transformation_api.main:main"

[tool.setuptools-git-versioning]
enabled = true


[tool.setuptools.packages.find]
where = ["src"] # list of folders that contain the packages (["."] by default)
include = ["coordinates_transformation_api*"] # package names should match these glob patterns (["*"] by default)
include = ["coordinate_transformation_api*"] # package names should match these glob patterns (["*"] by default)
namespaces = false # to disable scanning PEP 420 namespaces (true by default)

[tool.setuptools.package-data]
"coordinates_transformation_api.assets" = ["*"]
"coordinates_transformation_api.assets.static" = ["*"]
"coordinate_transformation_api.assets" = ["*"]
"coordinate_transformation_api.assets.static" = ["*"]

[tool.ruff]
# see https://beta.ruff.rs/docs/rules/
Expand Down Expand Up @@ -138,11 +138,11 @@ target-version = "py39"
"ANN" # no type annotation required
]

"src/coordinates_transformation_api/cityjson/models.py" = [
"src/coordinate_transformation_api/cityjson/models.py" = [
"N815", # non-snakecase variables allowed
]

"src/coordinates_transformation_api/util.py" = [
"src/coordinate_transformation_api/util.py" = [
"ANN",
]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
openapi: "3.1.0"
info:
title: NSGI Coordinates Transformation API
title: NSGI Coordinate Transformation API
version: 2.0.0
description: >
The Coordinates Transformation API performs coordinate transformations on GeoJSON and CityJSON files using the official RDNAPTRANS™
The Coordinate Transformation API performs coordinate transformations on GeoJSON and CityJSON files using the official RDNAPTRANS™
transformation procedure.
contact:
name: NSGI
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
from pydantic import AnyUrl, BaseModel, ConfigDict, EmailStr, Field, StringConstraints
from pyproj import CRS

from coordinates_transformation_api.crs_transform import get_transform_crs_fun
from coordinate_transformation_api.crs_transform import get_transform_crs_fun

CityJSONBoundary = Union[
list[list[list[int]]],
Expand Down
Loading

0 comments on commit f7897ec

Please sign in to comment.