Skip to main content

This is an package mainly for in-house usage. There are a lot of admin packages used that might not work well in your environment (ex: django-rq instead of celery for background jobs). Its primary goal is to help springboard new Digital Humanities mapping projects with a decent amount of flexability.

If you cannot directly use this package, consider forking and customizing for your own usage/environment or just use it for inspiration.

Requirements

  • gdal, gdal-tools for postgis and overhead tile generation
  • ffmpeg for video resolution and thumbnail generation
  • libmagic for image processing
  • redis for background job support
  • Assumes postgres database with gis (postgis)

Install

Add all the deps (including django_dh_map) to your INSTALLED_APPS

INSTALLED_APPS = [
    ...,
    'django_dh_map',
    'admin_interface',
    'colorfield',
    'nested_admin',
    'django_jsonform',
    'adminsortable2',
    'solo',
    'tinymce',
    'admin_async_upload',
    'imagekit',
    'django_rq',
    'django.contrib.gis',
    'django.contrib.postgres',
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'polymorphic',
    'rest_framework',
    'rest_framework_gis',
    ...,
]

Add the urls to your project

urlpatterns = [
    ...,
    # django-async-upload endpoints
    path('admin_async_upload/', include('admin_async_upload.urls')),
    # tinymce endpoints
    path('tinymce/', include('tinymce.urls')),
    # django_rq admin endpoints
    path('django-rq/', include('django_rq.urls')),
    # django_dh_map endpoints
    path('', include("django_dh_map.urls")),
    ...,
]

Run python manage.py migrate

Include the package javascript and css into your base.html file's head section

{% load static %}
...
<head>
    ...
    <link rel="stylesheet" href="{% static 'django_dh_map/dist/django_dh_map.css' %}">
    <script src="{% static 'django_dh_map/dist/django_dh_map.js' %}" defer></script>
    ...
</head>

Example Project

See example/README.md for instructions for running the example app (using Docker). Run the docker compose commands from the root directory.

Development

Build assets

# install node_modules
docker run --rm -it -v $PWD:/app/ -w /app/vite node:25.5 yarn

# build assets
docker run --rm -it -v $PWD:/app/ -w /app/vite node:25.5 yarn build

# build assets and watch for changes
docker run --rm -it -v $PWD:/app/ -w /app/vite node:25.5 yarn watch
docker run --rm -it -v $PWD:/app/ -w /app/vite node:25.5 yarn watch_dist

Download files

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

Source Distribution

django_dh_map-0.3.1.tar.gz (2.8 MB view details)

Uploaded Source

Built Distribution

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

django_dh_map-0.3.1-py3-none-any.whl (2.6 MB view details)

Uploaded Python 3

File details

Details for the file django_dh_map-0.3.1.tar.gz.

File metadata

  • Download URL: django_dh_map-0.3.1.tar.gz
  • Upload date:
  • Size: 2.8 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for django_dh_map-0.3.1.tar.gz
Algorithm Hash digest
SHA256 79bfbfa6d44fabb76da7eca4695e0a073a8f6c1717e662b8c8c6440fffb836f0
MD5 b666891f8ce69a7b85a50666f8cfe01a
BLAKE2b-256 2f9de860f4cde62acf4e1e1e4e9c0693e863a4e99a2261879229421918f9c3c8

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_dh_map-0.3.1.tar.gz:

Publisher: main.yaml on sfu-dhil/django-dh-map

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

File details

Details for the file django_dh_map-0.3.1-py3-none-any.whl.

File metadata

  • Download URL: django_dh_map-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 2.6 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for django_dh_map-0.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 616e2063f639d7a9a9b51ad4cedaed80f1d40502ca97c9e9d86827195d615f05
MD5 927bdc36d9cf5e014f49b76c9d496341
BLAKE2b-256 8b8d15e3e78c9c063a5f9766835cd1ca85f9434b19a7052ff6b76031ef8d35a6

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_dh_map-0.3.1-py3-none-any.whl:

Publisher: main.yaml on sfu-dhil/django-dh-map

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

Release history Release notifications | RSS feed

0.3.5

2 files

0.3.4

2 files

0.3.3

2 files

This release

0.3.1 This release

2 files

0.3.0

2 files

0.2.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page