Initial commit

Author: tino097

.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: ckan/ckan-dev:2.10
+    services:
+      solr:
+        image: ckan/ckan-solr:2.10-solr9
+      postgres:
+        image: ckan/ckan-postgres-dev:2.10
+        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@v4
+    - 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.twdh_reports --disable-warnings ckanext/twdh_reports
+

.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/

MANIFEST.in

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

README.md

@@ -1 +1,123 @@
+[![Tests](https://github.com/tino097/ckanext-twdh_reports/workflows/Tests/badge.svg?branch=main)](https://github.com/tino097/ckanext-twdh_reports/actions)
+
 # ckanext-twdh_reports
+
+**TODO:** Put a description of your extension here:  What does it do? What features does it have? Consider including some screenshots or embedding a video!
+
+
+## Requirements
+
+**TODO:** For example, you might want to mention here which versions of CKAN this
+extension works with.
+
+If your extension works across different versions you can add the following table:
+
+Compatibility with core CKAN versions:
+
+| CKAN version    | Compatible?   |
+| --------------- | ------------- |
+| 2.6 and earlier | not tested    |
+| 2.7             | not tested    |
+| 2.8             | not tested    |
+| 2.9             | not tested    |
+
+Suggested values:
+
+* "yes"
+* "not tested" - I can't think of a reason why it wouldn't work
+* "not yet" - there is an intention to get it working
+* "no"
+
+
+## Installation
+
+**TODO:** Add any additional install steps to the list below.
+   For example installing any non-Python dependencies or adding any required
+   config settings.
+
+To install ckanext-twdh_reports:
+
+1. Activate your CKAN virtual environment, for example:
+
+     . /usr/lib/ckan/default/bin/activate
+
+2. Clone the source and install it on the virtualenv
+
+    git clone https://github.com/tino097/ckanext-twdh_reports.git
+    cd ckanext-twdh_reports
+    pip install -e .
+	pip install -r requirements.txt
+
+3. Add `twdh_reports` 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
+
+
+## Config settings
+
+None at present
+
+**TODO:** Document any optional config settings here. For example:
+
+	# The minimum number of hours to wait before re-checking a resource
+	# (optional, default: 24).
+	ckanext.twdh_reports.some_setting = some_default_value
+
+
+## Developer installation
+
+To install ckanext-twdh_reports for development, activate your CKAN virtualenv and
+do:
+
+    git clone https://github.com/tino097/ckanext-twdh_reports.git
+    cd ckanext-twdh_reports
+    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 ckanext-twdh_reports
+
+If ckanext-twdh_reports 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
+
+[AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html)

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__)

ckanext/twdh_reports/__init__.py

@@ -0,0 +1,10 @@
+ckan.module("twdh_reports-module", function ($, _) {
+  "use strict";
+  return {
+    options: {
+      debug: false,
+    },
+
+    initialize: function () {},
+  };
+});

ckanext/twdh_reports/assets/.gitignore

@@ -0,0 +1,5 @@
+/*
+body {
+  border-radius: 0;
+}
+*/

ckanext/twdh_reports/assets/script.js

@@ -0,0 +1,14 @@
+# twdh_reports-js:
+#   filter: rjsmin
+#   output: ckanext-twdh_reports/%(version)s-twdh_reports.js
+#   contents:
+#     - js/twdh_reports.js
+#   extra:
+#     preload:
+#       - base/main
+
+# twdh_reports-css:
+#   filter: cssrewrite
+#   output: ckanext-twdh_reports/%(version)s-twdh_reports.css
+#   contents:
+#     - css/twdh_reports.css

ckanext/twdh_reports/assets/style.css

@@ -0,0 +1,16 @@
+import ckan.plugins as plugins
+import ckan.plugins.toolkit as toolkit
+
+
+class TwdhReportsPlugin(plugins.SingletonPlugin):
+    plugins.implements(plugins.IConfigurer)
+    
+
+    # IConfigurer
+
+    def update_config(self, config_):
+        toolkit.add_template_directory(config_, "templates")
+        toolkit.add_public_directory(config_, "public")
+        toolkit.add_resource("assets", "twdh_reports")
+
+    

ckanext/twdh_reports/assets/webassets.yml

@@ -0,0 +1,56 @@
+"""
+Tests for plugin.py.
+
+Tests are written using the pytest library (https://docs.pytest.org), and you
+should read the testing guidelines in the CKAN docs:
+https://docs.ckan.org/en/2.9/contributing/testing.html
+
+To write tests for your extension you should install the pytest-ckan package:
+
+    pip install pytest-ckan
+
+This will allow you to use CKAN specific fixtures on your tests.
+
+For instance, if your test involves database access you can use `clean_db` to
+reset the database:
+
+    import pytest
+
+    from ckan.tests import factories
+
+    @pytest.mark.usefixtures("clean_db")
+    def test_some_action():
+
+        dataset = factories.Dataset()
+
+        # ...
+
+For functional tests that involve requests to the application, you can use the
+`app` fixture:
+
+    from ckan.plugins import toolkit
+
+    def test_some_endpoint(app):
+
+        url = toolkit.url_for('myblueprint.some_endpoint')
+
+        response = app.get(url)
+
+        assert response.status_code == 200
+
+
+To temporary patch the CKAN configuration for the duration of a test you can use:
+
+    import pytest
+
+    @pytest.mark.ckan_config("ckanext.myext.some_key", "some_value")
+    def test_some_action():
+        pass
+"""
+import ckanext.twdh_reports.plugin as plugin
+
+
+@pytest.mark.ckan_config("ckan.plugins", "twdh_reports")
+@pytest.mark.usefixtures("with_plugins")
+def test_plugin():
+    assert plugin_loaded("twdh_reports")

ckanext/twdh_reports/i18n/.gitignore

@@ -0,0 +1 @@
+pytest-ckan