Merge pull request #1 from JiscSD/create_map_view

New extension to allow map view for CKAN dataset

Author: paulchauch

.coveragerc

@@ -0,0 +1,5 @@
+[report]
+omit =
+    */site-packages/*
+    */python?.?/*
+    ckan/*

.github/workflows/test.yml

@@ -0,0 +1,48 @@
+name: Tests
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    container:
+      # The CKAN version tag of the Solr and Postgres containers should match
+      # the one of the container the tests run on.
+      # You can switch this base image with a custom image tailored to your project
+      image: openknowledge/ckan-dev:2.9
+    services:
+      solr:
+        image: ckan/ckan-solr-dev:2.9
+      postgres:
+        image: ckan/ckan-postgres-dev:2.9
+        env:
+          POSTGRES_USER: postgres
+          POSTGRES_PASSWORD: postgres
+          POSTGRES_DB: postgres
+        options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
+      redis:
+          image: redis:3
+
+    env:
+      CKAN_SQLALCHEMY_URL: postgresql://ckan_default:pass@postgres/ckan_test
+      CKAN_DATASTORE_WRITE_URL: postgresql://datastore_write:pass@postgres/datastore_test
+      CKAN_DATASTORE_READ_URL: postgresql://datastore_read:pass@postgres/datastore_test
+      CKAN_SOLR_URL: http://solr:8983/solr/ckan
+      CKAN_REDIS_URL: redis://redis:6379/1
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install requirements
+      # Install any extra requirements your extension has here (dev requirements, other extensions etc)
+      run: |
+        pip install -r requirements.txt
+        pip install -r dev-requirements.txt
+        pip install -e .
+    - name: Setup extension
+      # Extra initialization steps
+      run: |
+        # Replace default path to CKAN core config file with the one on the container
+        sed -i -e 's/use = config:.*/use = config:\/srv\/app\/src\/ckan\/test-core.ini/' test.ini
+
+        ckan -c test.ini db init
+    - name: Run tests
+      run: pytest --ckan-ini=test.ini --cov=ckanext.dataset_geo_display --disable-warnings ckanext/dataset_geo_display
+

.gitignore

@@ -0,0 +1,42 @@
+.ropeproject
+node_modules
+bower_components
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+sdist/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.cache
+nosetests.xml
+coverage.xml
+
+# Sphinx documentation
+docs/_build/

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 JiscSD
+Copyright (c) 2022 Jisc
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

MANIFEST.in

@@ -0,0 +1,5 @@
+include README.rst
+include LICENSE
+include requirements.txt
+recursive-include ckanext/dataset_geo_display *.html *.json *.js *.less *.css *.mo *.yml
+recursive-include ckanext/dataset_geo_display/migration *.ini *.py *.mako

README.md

@@ -1,2 +1,112 @@
+[![Tests](https://github.com/JiscSD/ckanext-dataset_geo_display/workflows/Tests/badge.svg?branch=main)](https://github.com/JiscSD/ckanext-dataset_geo_display/actions)
+
 # ckanext-dataset_geo_display
-A CKAN extension to all map display based on the dataset wkt data
+
+This is a CKAN extension that works to help placing the map display for datasets to illustrate the geography coverage of the dataset.
+
+It is currently using hosted version of leaflet 
+
+
+## Requirements
+
+This plugin is developed and tested on CKAN version 2.9
+
+Compatibility with core CKAN versions:
+
+| CKAN version    | Compatible?   |
+| --------------- | ------------- |
+| 2.6 and earlier | no            |
+| 2.7             | no            |
+| 2.8             | not tested    |
+| 2.9             | yes    	      |
+
+## Installation
+
+To install dataset_geo_display:
+
+1. Activate your CKAN virtual environment, for example:
+```
+     . /usr/lib/ckan/default/bin/activate
+```
+2. Clone the source and install it on the virtualenv
+
+(make sure the pip here is using the CKAN virtual environment pip, instead of the system pip)
+
+(to ensure the pip, one can specifically denoted the pip by using the pip under ckan folder)
+
+```
+    git clone https://github.com/JiscSD/ckanext-dataset_geo_display.git
+    cd ckanext-dataset_geo_display
+    pip install -e .
+    pip install -r requirements.txt
+```
+3. Add `dataset_geo_display` to the `ckan.plugins` setting in your CKAN
+   config file (by default the config file is located at
+   `/etc/ckan/default/ckan.ini`).
+
+4. Restart CKAN. For example if you've deployed CKAN with Apache on Ubuntu:
+```
+     sudo service apache2 reload
+```
+or if the server is on AWS, called
+```
+     sudo reboot now 
+```
+
+## Dependency
+
+The extension requires python library [geomet](https://github.com/geomet/geomet), and js library [leaflet](https://leafletjs.com/index.html).
+
+## Developer installation
+
+To install ckanext-dataset_geo_display for development, activate your CKAN virtualenv and
+do:
+```
+    git clone https://github.com/JiscSD/ckanext-dataset_geo_display.git
+    cd dataset_geo_display
+    python setup.py develop
+    pip install -r dev-requirements.txt
+```
+
+## Tests
+
+To run the tests, do:
+```
+    pytest --ckan-ini=test.ini
+```
+
+## Releasing a new version of dataset_geo_display
+
+If dataset_geo_display should be available on PyPI you can follow these steps to publish a new version:
+
+1. Update the version number in the `setup.py` file. See [PEP 440](http://legacy.python.org/dev/peps/pep-0440/#public-version-identifiers) for how to choose version numbers.
+
+2. Make sure you have the latest version of necessary packages:
+```
+    pip install --upgrade setuptools wheel twine
+```
+3. Create a source and binary distributions of the new version:
+```
+       python setup.py sdist bdist_wheel && twine check dist/*
+```
+   Fix any errors you get.
+
+4. Upload the source distribution to PyPI:
+```
+       twine upload dist/*
+```
+5. Commit any outstanding changes:
+```
+       git commit -a
+       git push
+```
+6. Tag the new release of the project on GitHub with the version number from
+   the `setup.py` file. For example if the version number in `setup.py` is
+   0.0.1 then do:
+```
+       git tag 0.0.1
+       git push --tags
+```
+## License
+
+[MIT](https://opensource.org/licenses/MIT)

ckanext/__init__.py

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+# this is a namespace package
+try:
+    import pkg_resources
+    pkg_resources.declare_namespace(__name__)
+except ImportError:
+    import pkgutil
+    __path__ = pkgutil.extend_path(__path__, __name__)