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/show/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.3.tar.gz (17.6 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.3-py3-none-any.whl (11.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gov_service-0.0.3.tar.gz
  • Upload date:
  • Size: 17.6 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.3.tar.gz
Algorithm Hash digest
SHA256 663c39d70f83496af2ed0b9701525f09b6560476c7b693ed2e58d4bc1a593015
MD5 4b107926e60fefc327be65a7c3cd975a
BLAKE2b-256 6463c0acd09b61c11a17357c2c55390054b4c295df664c26f8d438cb781dc8b1

See more details on using hashes here.

Provenance

The following attestation bundles were made for gov_service-0.0.3.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.3-py3-none-any.whl.

File metadata

  • Download URL: gov_service-0.0.3-py3-none-any.whl
  • Upload date:
  • Size: 11.8 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.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a70fbb1b34eb1187beea6ea3d7cb380852607297b6accdeea800d8b285971bc6
MD5 4bf51d885d02fcd4dbeaea912cc505ff
BLAKE2b-256 2d6adfd38acacc20af81a52983f5ed1d50ca1873c71b05d3daa69ce69f40ce64

See more details on using hashes here.

Provenance

The following attestation bundles were made for gov_service-0.0.3-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