merge main

.github/workflows/pypi.yml

@@ -0,0 +1,105 @@
+name: upload-pypi
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: write
+  id-token: write
+
+
+jobs:
+  release-build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Set version from release tag
+        run: echo "VERSION=${{ github.event.release.tag_name }}" >> $GITHUB_ENV
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.x"
+
+      - name: Build release distributions
+        run: |
+          # NOTE: put your own distribution build steps here.
+          python -m pip install build
+          python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+  pypi-publish:
+    runs-on: ubuntu-latest
+    needs:
+      - release-build
+    permissions:
+      # IMPORTANT: this permission is mandatory for trusted publishing
+      id-token: write
+
+    # Dedicated environments with protections for publishing are strongly recommended.
+    # For more information, see: https://docs.github.com/en/actions/deployment/targeting-different-environments/using-environments-for-deployment#deployment-protection-rules
+    environment:
+      name: pypi
+      # OPTIONAL: uncomment and update to include your PyPI project URL in the deployment status:
+      #url: https://pypi.org/p/${GITHUB_REPOSITORY#*/}
+      #
+      # ALTERNATIVE: if your GitHub Release name is the PyPI project version string
+      # ALTERNATIVE: exactly, uncomment the following line instead:
+      url: https://pypi.org/project/${GITHUB_REPOSITORY#*/}/${{ github.event.release.name }}
+
+    steps:
+      - name: Retrieve release distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: release-dists
+          path: dist/
+
+      - name: Publish release distributions to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          packages-dir: dist/
+  sign-package:
+    runs-on: ubuntu-latest
+    needs:
+    - release-build
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: release-dists
+        path: dist/
+    - name: Sign the dists with Sigstore
+      uses: sigstore/gh-action-sigstore-python@v3.0.0
+      with:
+        inputs: >-
+          ./dist/*.tar.gz
+          ./dist/*.whl
+  publish-to-testpypi:
+    name: Publish Python 🐍 distribution 📦 to TestPyPI
+    needs:
+    - release-build
+    runs-on: ubuntu-latest
+
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/${GITHUB_REPOSITORY#*/}
+
+    permissions:
+      id-token: write  # IMPORTANT: mandatory for trusted publishing
+
+    steps:
+    - name: Download all the dists
+      uses: actions/download-artifact@v4
+      with:
+        name: release-dists
+        path: dist/
+    - name: Publish distribution 📦 to TestPyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        repository-url: https://test.pypi.org/legacy/

.github/workflows/test.yml

@@ -8,7 +8,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v4
         with:
-          python-version: '3.7'
+          python-version: '3.11'
       - name: Install requirements
         run: pip install flake8 pycodestyle
       - name: Check syntax
@@ -18,16 +18,25 @@ jobs:
     needs: lint
     strategy:
       matrix:
-        ckan-version: ["2.10", 2.9]
+        include:
+          - ckan-version: "2.11"
+            ckan-image: "ckan/ckan-dev:2.11-py3.10"
+            solr-image: "2.11-solr9-spatial"
+            harvester-version: 'master'
+          - ckan-version: "2.10"
+            ckan-image: "ckan/ckan-dev:2.10-py3.10"
+            solr-image: "2.10-solr9-spatial"
+            harvester-version: 'master'
       fail-fast: false
 
-    name: CKAN ${{ matrix.ckan-version }}
+    name: CKAN ${{ matrix.ckan-version }}, Solr ${{ matrix.solr-image }}
     runs-on: ubuntu-latest
     container:
-      image: ckan/ckan-dev:${{ matrix.ckan-version }}
+      image: ${{ matrix.ckan-image }}
+      options: --user root
     services:
       solr:
-        image: ckan/ckan-solr:${{ matrix.ckan-version }}
+        image: ckan/ckan-solr:${{ matrix.solr-image }}
       postgres:
         image: ckan/ckan-postgres-dev:${{ matrix.ckan-version }}
         env:
@@ -36,14 +45,14 @@ jobs:
           POSTGRES_DB: postgres
         options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
       redis:
-          image: redis:3
+        image: redis:7
     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@v3
     - name: Install requirements
@@ -63,4 +72,4 @@ jobs:
     - name: Upload coverage report to codecov
       uses: codecov/codecov-action@v1
       with:
-        file: ./coverage.xml
+        file: ./coverage.xml--cov=ckanext.matolabtheme

MANIFEST.in

@@ -3,3 +3,4 @@ include LICENSE
 include requirements.txt
 recursive-include ckanext/matolabtheme *.html *.json *.js *.less *.css *.mo *.yml
 recursive-include ckanext/matolabtheme/migration *.ini *.py *.mako
+recursive-include ckanext/matolabtheme/public/static *.svg *.png

README.md

@@ -1,24 +1,17 @@
 [![Tests](https://github.com/Mat-O-Lab/ckanext-matolabtheme/actions/workflows/test.yml/badge.svg)](https://github.com/Mat-O-Lab/ckanext-matolabtheme/actions/workflows/test.yml)
 # ckanext-matolabtheme
 
-**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!
-
+CKAN theme of the Mat-O-Lab Project, changes landing Page and add alternative Data Privacy Act in English and German.  
 
 ## 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    |
+| 2.9 and earlier | not tested    |
+| 2.10            | yes           |
+| 2.11            | yes           |
 
 Suggested values:
 
@@ -30,106 +23,64 @@ Suggested values:
 
 ## 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-matolabtheme:
+To install the extension:
 
 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/Mat-O-Lab/ckanext-matolabtheme.git
-    cd ckanext-matolabtheme
-    pip install -e .
-	pip install -r requirements.txt
-
+```bash
+. /usr/lib/ckan/default/bin/activate
+```
+2. Use pip to install package
+```bash
+pip install ckanext-matolabtheme
+```
 3. Add `matolabtheme` 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 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:
+```bash
+sudo service apache2 reload
+```
 
 ## Config settings
 
 ```bash
-CKANINI__CKANEXT__MATOLABTHEME__CONTACT_URL = <url to contact site>
-CKANINI__CKANEXT__MATOLABTHEME__LEGAL_PERSON_MD = <Legal Body Address in Markdown>
-CKANINI__CKANEXT__MATOLABTHEME__DSVGO_CONTACT_MD = <Contact to adress with dsvgo conflicts in markdown>
+CKANINI__CKANEXT__MATOLABTHEME__CONTACT_URL=<url to contact site>
+CKANINI__CKANEXT__MATOLABTHEME__LEGAL_PERSON_MD=<Legal Body Address in Markdown>
+CKANINI__CKANEXT__MATOLABTHEME__LEGAL_NOTICE_URL=<Url to your legal notice information>
+CKANINI__CKANEXT__MATOLABTHEME__DSVGO_CONTACT_MD=<Contact to adress with dsvgo conflicts in markdown>
+CKANINI__CKANEXT__MATOLABTHEME__CONTACT_DP_COMMISSIONER_EMAIL_MD="[datenprotection_commissioner@example.de](mailto:datenschutzbeauftragte@example.de?subject=dataprotection ${CKAN_HOST})"
 CKANINI__CKAN__FAVICON=/img/favicon.png
 ```
 or ckan.ini parameters.
 ```bash
 ckan.matolabtheme.contact_url = <url to contact site>
 ckan.matolabtheme.legal_person_md = <Legal Body Address in Markdown>
+ckan.matolabtheme.legal_notice_url = <Url to your legal notice information>
 ckan.matolabtheme.dsvgo_contact_md = <Contact to adress with dsvgo conflicts in markdown>
+ckan.matolabtheme.dsvgo_contact_md = "[datenprotection_commissioner@example.de](mailto:datenschutzbeauftragte@example.de?subject=dataprotection]"
 ckan.favicon = /img/favicon.png
 ```
 If no contact_url is given, it will relate to the about page!
 
 
-**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.matolabtheme.some_setting = some_default_value
-
-
 ## Developer installation
 
-To install ckanext-matolabtheme for development, activate your CKAN virtualenv and
+To install ckanext-csvtocsvw for development, activate your CKAN virtualenv and
 do:
-
-    git clone https://github.com/Mat-O-Lab/ckanext-matolabtheme.git
-    cd ckanext-matolabtheme
-    python setup.py develop
-    pip install -r dev-requirements.txt
-
+```bash
+git clone https://github.com/Mat-O-Lab/ckanext-matolabtheme.git
+cd ckanext-matolabtheme
+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-matolabtheme
-
-If ckanext-matolabtheme 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
+```bash
+pytest --ckan-ini=test.ini
+```
 
 ## License