Jérôme Lebleu c6beb75a46 | ||
---|---|---|
tests | ||
wagtail_maps | ||
.editorconfig | ||
.gitignore | ||
LICENSE | ||
MANIFEST.in | ||
Makefile | ||
README.md | ||
pyproject.toml | ||
setup.cfg | ||
setup.py | ||
tox.ini |
README.md
wagtail-maps
Create and display maps with points in Wagtail.
Warning! This project is still early on in its development lifecycle. It is possible for breaking changes to occur between versions until reaching a stable 1.0. Feedback and pull requests are welcome.
This package extend Wagtail to add a new Map model, which is composed by one or more points. Each point may have a title, some content and link to an internal or external URL. Once you have configured your map from the Wagtail admin, you will be able to display it in a page - e.g. as a StreamField block.
Requirements
This package requires the following:
- Python (3.7, 3.8, 3.9)
- Django (2.2, 3.1, 3.2)
- Wagtail (2.11, 2.14)
Older versions of Wagtail could work too but they are not tested. The efforts are focused in LTS and recent versions.
Installation
- Install using
pip
:pip install wagtail-maps
- Add
wagtail_maps
to yourINSTALLED_APPS
setting:INSTALLED_APPS = [ # ... 'wagtail_maps', # ... ]
- Include the URL of wagtail-maps to your
urls.py
file:from wagtail_maps import urls as wagtailmaps_urls urlpatterns = [ # ... path('maps/', include(wagtailmaps_urls)), # ... ]
- Run
python manage.py migrate
to create the models
Development
Quick start
To set up a development environment, ensure that Python 3 is installed on your system. Then:
- Clone this repository
- Create a virtual environment and activate it:
python3 -m venv venv source venv/bin/activate
- Install this package in develop mode with extra requirements:
pip install -e .[test]
Contributing
The Python code is formatted and linted thanks to flake8, isort and black. To ease the use of this tools, the following commands are available:
make lint
: check the Python code syntax and imports ordermake format
: fix the Python code syntax and imports order
The tests are written with pytest and code coverage is measured with coverage. You can use the following commands for that:
make test
: run the tests and output a quick report of code coveragemake coverage
: run the tests and produce an HTML report of code coverage
When submitting a pull-request, please ensure that the code is well formatted and covered, and that all the other tests pass.
License
This extension is mainly developed by Cliss XXI and licensed under the AGPLv3+. Any contribution is welcome!