Django Location API

Django package for location services.

• Free software: BSD-3-Clause
• Documentation: https://django-location-api.readthedocs.io.

django-location-api is a Django app for location services.

Detailed documentation is in the "docs" directory.

Quick start

1. Add "location_api" and the other required packages to your INSTALLED_APPS setting like this:

   INSTALLED_APPS = [
       ...,
       "rest_framework",
       "rest_framework_gis",
       "location_api"
   ]
   

2. Include the location_api URL conf in your project urls.py like this:

   path("api/", include("location_api.urls")),
   path("", include("location_api.urls.search")),
   

3. Run python manage.py migrate to create the location models.

4. Start the development server and visit the admin site to create a location.

5. Access the /locations/ URL.

Development

This project uses uv for dependency management.

Install dependencies:

uv sync

Run tests:

docker compose run --rm django python ./runtests.py

Format code:

uv run invoke format

Run linting:

uv run invoke lint

Create migrations:

docker compose run --rm django python example/manage.py makemigrations

Credits

This package was created with Cookiecutter and the briggySmalls/cookiecutter-pypackage project template.