https://github.com/nens/threedi-api-qgis-client

3Di Models & Simulations plugin
https://github.com/nens/threedi-api-qgis-client

Last synced: 4 days ago
JSON representation

3Di Models & Simulations plugin

• Host: GitHub
• URL: https://github.com/nens/threedi-api-qgis-client
• Owner: nens
• License: other
• Created: 2020-02-20T12:47:52.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-04-22T10:26:12.000Z (7 months ago)
• Last Synced: 2024-04-22T11:37:56.650Z (7 months ago)
• Language: Python
• Homepage: https://plugins.lizard.net/
• Size: 13.4 MB
• Stars: 2
• Watchers: 12
• Forks: 0
• Open Issues: 83
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Authors: AUTHORS.rst

Awesome Lists containing this project

README

        
=======================

threedi-api-qgis-client

=======================

.. image:: https://travis-ci.com/nens/threedi-api-qgis-client.svg?branch=master

        :target: https://travis-ci.com/nens/threedi-api-qgis-client

Deployment

----------

Make sure you have ``zest.releaser`` with ``qgispluginreleaser`` installed. The

``qgispluginreleaser`` ensures the metadata.txt, which is used by the qgis plugin

manager, is also updated to the new version. To make a new release enter the following

commands and follow their steps::

    $ cd /path/to/the/plugin

    $ fullrelease

This creates a new release and tag on github. Additionally, a zip file

``threedi_models_and_simulations..zip`` is created. Upload this zip-file to

https://artifacts.lizard.net/ via the ``upload-artifact.sh`` script. You'll need

to set $ARTIFACTS_KEY environment variable. Get the key from

https://artifacts.lizard.net/admin/ Afterwards run it like this::

    $ docker compose run --rm qgis make clean

    $ docker compose run --rm qgis make zip

    $ bash upload-artifact.sh threedi_models_and_simulations..zip

Local development notes

-----------------------

On Linux, local development happens with docker to make sure we're working in a nicely

isolated environment. To start the development environment, run the following commands::

    $ docker compose build

    $ xhost +local:docker

    $ docker compose up

and::

    $ docker compose run --rm qgis make test

On Mac, you might need to install xquartz, adjust the DISPLAY env variable in the docker-compose.yml

to `host.docker.internal:0` and remove the //tmp/x-something mount from volumes. Then, to start the

development environment, run the following commands::

    $ docker compose build

    $ xhost +localhost

    $ docker compose up