Skip to main content

gov-service: A local GOV (Geschichtliches Ortsverzeichnis) server service

Project description

gov-service

PyPi PyPI Status License pypi format downloads
GitHub Github Actions Build Release Contributors Last Commit GitHub issues GitHub closed issues
Code style-black imports-isort
Docs API Docs formatter-docformatter style-google

A local GOV (Geschichtliches Ortsverzeichnis) server service, usable as an alternative GOV server via the GOV-Tag base_url option.

Command Line Testing

You can test queries directly from the command line using the scripts/gov_query tool:

# List available queries
scripts/gov_query -li

# Test the NameByGovId query with Schönberg's GOV-Kennung
scripts/gov_query -qn NameByGovId --params gov_id=SCHERGJO54EJ -f json

API Testing

When the service is running (e.g. via scripts/startup --gov), you can test the REST API endpoint directly using curl:

# HTML (default)
curl -s http://localhost:8000/item/wikihtml/SCHERGJO54EJ

# JSON via Accept header
curl -s -H "Accept: application/json" http://localhost:8000/item/show/SCHERGJO54EJ

# YAML via Accept header
curl -s -H "Accept: application/x-yaml" http://localhost:8000/item/show/SCHERGJO54EJ

# JSON via format query parameter (overrides Accept header)
curl -s "http://localhost:8000/item/show/SCHERGJO54EJ?format=json"

API Documentation

The service is built with FastAPI, which automatically provides interactive API documentation when the server is running:

Docs

GOV-Service on GOV-Wiki

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gov_service-0.0.4.tar.gz (17.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gov_service-0.0.4-py3-none-any.whl (11.9 kB view details)

Uploaded Python 3

File details

Details for the file gov_service-0.0.4.tar.gz.

File metadata

  • Download URL: gov_service-0.0.4.tar.gz
  • Upload date:
  • Size: 17.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for gov_service-0.0.4.tar.gz
Algorithm Hash digest
SHA256 dab126cfdebc84cadbfaca1503ea88ae2bbcdc972b6f609848f27d8d64ae6345
MD5 d2361aa1f0ba342a5b0ba666bc5e0268
BLAKE2b-256 53c8ab1dff7437e4c8f62bf407ac0c83751f2f5741c46af254e10f6aca96bc6b

See more details on using hashes here.

Provenance

The following attestation bundles were made for gov_service-0.0.4.tar.gz:

Publisher: upload-to-pypi.yml on WolfgangFahl/gov-service

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gov_service-0.0.4-py3-none-any.whl.

File metadata

  • Download URL: gov_service-0.0.4-py3-none-any.whl
  • Upload date:
  • Size: 11.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for gov_service-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 23ec40b3f17c398d82f9fdc0f840f72868916026fd98dc5de8fe3b332d9d90b7
MD5 3379a64f29f0c71d7f88dc8f7dc570a0
BLAKE2b-256 02d1772ac5a7b3e5096a9158d3ce3ccb43bb857776eb8aae582979b666f3c6ea

See more details on using hashes here.

Provenance

The following attestation bundles were made for gov_service-0.0.4-py3-none-any.whl:

Publisher: upload-to-pypi.yml on WolfgangFahl/gov-service

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page