Skip to main content

Tools to work with Amsterdam schema.

Project description

amsterdam-schema-tools

Set of libraries and tools to work with Amsterdam schema.

Install the package with: pip install amsterdam-schema-tools

Currently, the following cli commands are available:

  • schema import schema
  • schema import ndjson
  • schema show schema
  • schema show tablenames
  • schema introspect db
  • schema introspect geojson *.geojson
  • schema validate

The tools expect either a DATABASE_URL environment variable or a command-line option --db-url with a DSN.

The output is a json-schema output according to the Amsterdam schemas definition for the tables that are being processed.

Generate amsterdam schema from existing database tables

The --prefix argument controls whether table prefixes are removed in the schema, because that is required for Django models.

As example we can generate a BAG schema. Point DATABASE_URL to bag_v11 database and then run :

schema show tablenames | sort | awk '/^bag_/{print}' | xargs schema introspect db bag --prefix bag_ | jq

The jq formats it nicely and it can be redirected to the correct directory in the schemas repository directly.

Express amsterdam schema information in relational tables

Amsterdam schema is expressed as jsonschema. However, to make it easier for people with a more relational mind- or toolset it is possible to express amsterdam schema as a set of relational tables. These tables are meta_dataset, meta_table and meta_field.

It is possible to convert a jsonschema into the relational table structure and vice-versa.

This command converts a dataset from an existing dataset in jsonschema format:

schema import schema <id of dataset>

To convert from relational tables back to jsonschema:

schema show schema <id of dataset>

Generating amsterdam schema from existing GeoJSON files

The following command can be used to inspect and import the GeoJSON files:

schema introspect geojson <dataset-id> *.geojson > schema.json
edit schema.json  # fine-tune the table names
schema import geojson schema.json <table1> file1.geojson
schema import geojson schema.json <table2> file2.geojson

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

amsterdam-schema-tools-0.9.9.tar.gz (31.1 kB view details)

Uploaded Source

Built Distribution

amsterdam_schema_tools-0.9.9-py3-none-any.whl (52.0 kB view details)

Uploaded Python 3

File details

Details for the file amsterdam-schema-tools-0.9.9.tar.gz.

File metadata

  • Download URL: amsterdam-schema-tools-0.9.9.tar.gz
  • Upload date:
  • Size: 31.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.10.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/2.7.17

File hashes

Hashes for amsterdam-schema-tools-0.9.9.tar.gz
Algorithm Hash digest
SHA256 d7faf293ece2e94f0fbc856cf5ce4cb95980627bdd4bca7c5479c92799d042d6
MD5 866a03ee389545e2034bcfab94d968fa
BLAKE2b-256 0c41d555a438f077f1d0c8f0e4ffe5e6bd1d56ec1b7001020864d037f3653158

See more details on using hashes here.

File details

Details for the file amsterdam_schema_tools-0.9.9-py3-none-any.whl.

File metadata

  • Download URL: amsterdam_schema_tools-0.9.9-py3-none-any.whl
  • Upload date:
  • Size: 52.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.10.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.32.2 CPython/2.7.17

File hashes

Hashes for amsterdam_schema_tools-0.9.9-py3-none-any.whl
Algorithm Hash digest
SHA256 1814c92700fd30e4efcad76a8fdaed4a1f7da949dcbb4279e717ac523e51f5db
MD5 4008345534e5643abf5f51042bdbc53f
BLAKE2b-256 fac1ee74b1a7fc1b4c5ec217383018a1fa5f57bed3e6653e90eda6beb75c312f

See more details on using hashes here.

Supported by

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