QFieldSync

This plugin facilitates packaging and synchronizing QGIS projects for use with QField.

It analyses the QGIS project and suggests and performs actions needed to make the project working on QField.

More information can be found in the QField documentation.

The plugin can be download on the QGIS plugin repository.

Contribute

QFieldSync is an open source project, licensed under the terms of the GPLv3 or later. This means that it is free to use and modify and will stay like that.

We are very happy if this app helps you to get your job done or in whatever creative way you may use it.

If you found it useful, we will be even happier if you could give something back. A couple of things you can do are:

• Rate the plugin at plugins.qgis.org ★★★★★
• Write about your experience (please let us know!).
• Help with the documentation.
• Translate the QFieldSync QGIS plugin, the QField app or the documentation.
• Sponsor a feature
• And just drop by to say thank you or have a beer with us next time you meet OPENGIS.ch at a conference.
• Develop a new feature or fix a bug.

Development

Getting the source code

1. Checkout qfieldsync locally:

git clone --recurse-submodules [email protected]:opengisch/qfieldsync.git

2. Make a link of the QFieldSync checkout to qfieldsync directory in your current QGIS profile:

ln -s ${PWD}/qfieldsync/qfieldsync ${HOME}/.local/share/QGIS/QGIS3/profiles/default/python/plugins

3. Checkout libqfieldsync locally:

git clone [email protected]:opengisch/libqfieldsync.git

4. Install your local libqfieldsync as editable dependency (assuming you are in the same directory as step 3):

pip install -e libqfieldsync

Note

On more recent Linux distributions you might get an error error: externally-managed-environment and you have to pass additional --break-system-packages. Despite the name, we promise this is not going to break system packages.

Opening a PR

Make sure each new feature or bug fix are in a separate PR.

QFieldSync stores the respective libqfieldsync commit SHA in the bottom of requirements.txt. Sometimes changes in QFieldSync require modifications in libqfieldsync. In these cases please update the commit sha of libqfieldsync to point to the respective commit on libqfieldsync's master branch.