DjangoGeoExporter

DjangoGeoExporter provides declarative flat, relational, and geospatial exports from Django querysets.

Quickstart

Install the package with the features required by your project:

poetry add "djangogeoexporter[all]"

Available extras are spreadsheet (XLSX and ODS), parquet, geo (GeoPackage), and all. With pip, use the equivalent command:

pip install "djangogeoexporter[all]"

Declare an export using your Django models:

from djangogeoexporter import ExportDefinition, ExportTable, Field, JSONField

from myapp.models import Commune, Observation


class ObservationsExport(ExportDefinition):
    name = "observations"
    tables = (
        ExportTable(
            "communes",
            Commune.objects.all(),
            ("id", "name", "geom"),
            geometry_field="geom",
            crs="EPSG:4326",
        ),
        ExportTable(
            "observations",
            Observation.objects.select_related("commune"),
            (
                "id",
                Field("commune", source="commune__name"),
                "observed_at",
            ),
        ),
    )

Generate the export and dispose of its temporary file when finished:

from shutil import copyfile

from djangogeoexporter import export

result = export(ObservationsExport, format="gpkg")
try:
    copyfile(result.path, result.filename)
finally:
    result.cleanup()

Supported formats include CSV, TSV, XLSX, ODS, Parquet/GeoParquet, and GeoPackage. Relational CSV and TSV exports are returned as ZIP archives.

JSON and JSONB fields

Django models.JSONField columns (backed by json or jsonb in PostgreSQL) are detected automatically. Their values are stored as strict, compact UTF-8 JSON text in every output format. This avoids format-dependent structures and allows the exported value to be consumed directly with json.loads(value) in Python or cast with value::jsonb in PostgreSQL. In particular, JSON null is exported as null, while a regular nullable field keeps the format's normal empty/null representation.

For a plain iterable, a computed field, or an annotation that cannot be identified through Django model metadata, mark the field explicitly:

ExportTable(
    "observations",
    rows,
    ("id", JSONField("metadata")),
)

Only standard JSON values are accepted. Non-standard floating-point values such as NaN and Infinity are rejected because PostgreSQL cannot import them as JSON/JSONB.

See the docs/ directory for configuration, dynamic export contexts, field labels, Django response integration, and format-specific options.