qfield-fetch 0.1.0__tar.gz

qfield_fetch-0.1.0/LICENSE

@@ -0,0 +1,339 @@
+ GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, write to the Free Software Foundation, Inc.,
+    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

qfield_fetch-0.1.0/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: qfield-fetch
+Version: 0.1.0
+Summary: Download QField AppImages and QField and QFieldCloud sources into one cache
+Keywords: QField,QFieldCloud,GIS,AppImage
+License-Expression: GPL-2.0-or-later
+License-File: LICENSE
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Testing
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Operating System :: POSIX
+Requires-Dist: typer>=0.16
+Requires-Python: >=3.12
+Project-URL: homepage, https://github.com/Joonalai/qfield-dev-tools
+Project-URL: repository, https://github.com/Joonalai/qfield-dev-tools
+Description-Content-Type: text/markdown
+
+# qfield-fetch
+
+Downloads QField release AppImages, and QField and QFieldCloud sources, into one cache.
+[pytest-qfield](https://github.com/Joonalai/qfield-dev-tools/tree/main/components/pytest-qfield) and [pytest-qfield-app](https://github.com/Joonalai/qfield-dev-tools/tree/main/components/pytest-qfield-app)
+fetch through it, and the command line manages the same cache.
+
+Each entry is fetched once, even by parallel processes such as pytest-xdist workers.
+Sources are shallow clones of the one ref asked for (`git clone --depth=1 --branch=<ref>`).
+
+## Install
+
+```bash
+pip install qfield-fetch
+```
+
+Fetching AppImages needs Linux. Cloning needs `git`.
+
+## Command line
+
+```bash
+qfield-fetch appimage 4.2.9          # prints .../appimage/4.2.9/AppRun
+qfield-fetch source 4.2.9            # tag v4.2.9, prints the checkout
+qfield-fetch source master --update  # a branch, cloned again after it moved
+qfield-fetch qfieldcloud latest      # newest QFieldCloud release
+qfield-fetch list
+qfield-fetch remove source v4.2.9
+```
+
+Versions take an optional `v`, and `latest` is the newest release. `qff` is a short
+alias of `qfield-fetch`.
+
+## Cache
+
+`~/.cache/qfield-fetch` (or `$XDG_CACHE_HOME/qfield-fetch`) by default. Set `QFIELD_FETCH_CACHE_DIR`,
+or pass `--cache-dir`, to use another one.
+
+```text
+appimage/4.2.9/AppRun
+source/v4.2.9/
+qfieldcloud/v26.30/
+```
+
+## Python
+
+```python
+from qfield_fetch import appimage, qfield_source, qfieldcloud_source
+
+app_run = appimage("4.2.9")
+checkout = qfield_source("release-4_3", update=True)
+```
+
+## Pytest options
+
+The package registers options that pytest-qfield and pytest-qfield-app share:
+
+| Option | Env | Ini |
+| --- | --- | --- |
+| `--qfield-version` | `QFIELD_VERSION` | `qfield_version` |
+| | `QFIELD_FETCH_CACHE_DIR` | `qfield_fetch_cache_dir`, relative to the rootdir |
+
+The option wins over the env, and the env over the ini. The `qfield_fetch_cache_dir` fixture
+returns the cache in use.

qfield_fetch-0.1.0/README.md

@@ -0,0 +1,62 @@
+# qfield-fetch
+
+Downloads QField release AppImages, and QField and QFieldCloud sources, into one cache.
+[pytest-qfield](https://github.com/Joonalai/qfield-dev-tools/tree/main/components/pytest-qfield) and [pytest-qfield-app](https://github.com/Joonalai/qfield-dev-tools/tree/main/components/pytest-qfield-app)
+fetch through it, and the command line manages the same cache.
+
+Each entry is fetched once, even by parallel processes such as pytest-xdist workers.
+Sources are shallow clones of the one ref asked for (`git clone --depth=1 --branch=<ref>`).
+
+## Install
+
+```bash
+pip install qfield-fetch
+```
+
+Fetching AppImages needs Linux. Cloning needs `git`.
+
+## Command line
+
+```bash
+qfield-fetch appimage 4.2.9          # prints .../appimage/4.2.9/AppRun
+qfield-fetch source 4.2.9            # tag v4.2.9, prints the checkout
+qfield-fetch source master --update  # a branch, cloned again after it moved
+qfield-fetch qfieldcloud latest      # newest QFieldCloud release
+qfield-fetch list
+qfield-fetch remove source v4.2.9
+```
+
+Versions take an optional `v`, and `latest` is the newest release. `qff` is a short
+alias of `qfield-fetch`.
+
+## Cache
+
+`~/.cache/qfield-fetch` (or `$XDG_CACHE_HOME/qfield-fetch`) by default. Set `QFIELD_FETCH_CACHE_DIR`,
+or pass `--cache-dir`, to use another one.
+
+```text
+appimage/4.2.9/AppRun
+source/v4.2.9/
+qfieldcloud/v26.30/
+```
+
+## Python
+
+```python
+from qfield_fetch import appimage, qfield_source, qfieldcloud_source
+
+app_run = appimage("4.2.9")
+checkout = qfield_source("release-4_3", update=True)
+```
+
+## Pytest options
+
+The package registers options that pytest-qfield and pytest-qfield-app share:
+
+| Option | Env | Ini |
+| --- | --- | --- |
+| `--qfield-version` | `QFIELD_VERSION` | `qfield_version` |
+| | `QFIELD_FETCH_CACHE_DIR` | `qfield_fetch_cache_dir`, relative to the rootdir |
+
+The option wins over the env, and the env over the ini. The `qfield_fetch_cache_dir` fixture
+returns the cache in use.

qfield_fetch-0.1.0/pyproject.toml

@@ -0,0 +1,82 @@
+[project]
+name = "qfield-fetch"
+description = "Download QField AppImages and QField and QFieldCloud sources into one cache"
+readme = "README.md"
+version = "0.1.0"
+keywords = [
+    "QField",
+    "QFieldCloud",
+    "GIS",
+    "AppImage",
+]
+license = "GPL-2.0-or-later"
+license-files = ["LICENSE"]
+requires-python = ">=3.12"
+classifiers = [
+    "Framework :: Pytest",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Testing",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3 :: Only",
+    "Operating System :: POSIX",
+]
+dependencies = ["typer>=0.16"]
+
+[project.urls]
+homepage = "https://github.com/Joonalai/qfield-dev-tools"
+repository = "https://github.com/Joonalai/qfield-dev-tools"
+
+[project.scripts]
+qfield-fetch = "qfield_fetch.cli:app"
+qff = "qfield_fetch.cli:app"
+
+[project.entry-points.pytest11]
+qfield-fetch = "qfield_fetch.pytest_plugin"
+
+[build-system]
+requires = ["uv_build>=0.10.9,<0.14.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "qfield_fetch"
+
+[tool.pytest.ini_options]
+addopts = "-p no:pytest-qfield -p no:pytest_qgis -p no:pytest-qt"
+testpaths = ["test"]
+
+[tool.semantic_release]
+commit_parser = "conventional-monorepo"
+major_on_zero = false
+allow_zero_version = true
+version_toml = ["pyproject.toml:project.version"]
+tag_format = "qfield-fetch-v{version}"
+commit_message = """
+chore(release): qfield-fetch {version}
+
+Automatically generated by python-semantic-release
+"""
+build_command = """
+    set -euo pipefail
+    python -m pip install uv
+    rm -rf dist
+    uv lock --upgrade-package "$PACKAGE_NAME"
+    git add ../../uv.lock
+    uv build --out-dir dist
+"""
+
+[tool.semantic_release.commit_parser_options]
+path_filters = ["."]
+scope_prefix = "fetch"
+minor_tags = ["feat"]
+patch_tags = [
+    "fix",
+    "build",
+]
+
+[tool.semantic_release.changelog]
+mode = "update"
+exclude_commit_patterns = ['(?!(?:feat|fix)(?:\([^)]*?\))?!?: ).*']
+
+[tool.semantic_release.branches.main]
+match = "(main)"
+prerelease_token = "dev"

qfield_fetch-0.1.0/pyproject.toml.orig

@@ -0,0 +1,81 @@
+[project]
+name = "qfield-fetch"
+description = "Download QField AppImages and QField and QFieldCloud sources into one cache"
+readme = "README.md"
+version = "0.1.0"
+keywords = ["QField", "QFieldCloud", "GIS", "AppImage"]
+license = "GPL-2.0-or-later"
+license-files = ["LICENSE"]
+requires-python = ">=3.12"
+classifiers = [
+    "Framework :: Pytest",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Testing",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3 :: Only",
+    "Operating System :: POSIX",
+]
+dependencies = [
+    "typer>=0.16",
+]
+
+[project.urls]
+homepage = "https://github.com/Joonalai/qfield-dev-tools"
+repository = "https://github.com/Joonalai/qfield-dev-tools"
+
+[project.scripts]
+qfield-fetch = "qfield_fetch.cli:app"
+qff = "qfield_fetch.cli:app"
+
+[project.entry-points.pytest11]
+qfield-fetch = "qfield_fetch.pytest_plugin"
+
+[build-system]
+requires = ["uv_build>=0.10.9,<0.14.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "qfield_fetch"
+
+[tool.pytest.ini_options]
+# The QGIS based plugins import Qt on load, these tests need none of it.
+addopts = "-p no:pytest-qfield -p no:pytest_qgis -p no:pytest-qt"
+testpaths = ["test"]
+
+[tool.semantic_release]
+commit_parser = "conventional-monorepo"
+major_on_zero = false
+allow_zero_version = true
+version_toml = ["pyproject.toml:project.version"]
+tag_format = "qfield-fetch-v{version}"
+commit_message = """\
+chore(release): qfield-fetch {version}
+
+Automatically generated by python-semantic-release
+"""
+build_command = """
+    set -euo pipefail
+    python -m pip install uv
+    rm -rf dist
+    uv lock --upgrade-package "$PACKAGE_NAME"
+    git add ../../uv.lock
+    uv build --out-dir dist
+"""
+
+[tool.semantic_release.commit_parser_options]
+path_filters = ["."]
+scope_prefix = "fetch"
+# Only feat, fix and build (dependency bumps) commits are releasable
+minor_tags = ["feat"]
+patch_tags = ["fix", "build"]
+
+[tool.semantic_release.changelog]
+mode = "update"
+# Keep only feat and fix commits in the changelog
+exclude_commit_patterns = [
+  '''(?!(?:feat|fix)(?:\([^)]*?\))?!?: ).*''',
+]
+
+[tool.semantic_release.branches.main]
+match = "(main)"
+prerelease_token = "dev"

qfield_fetch-0.1.0/src/qfield_fetch/__init__.py

@@ -0,0 +1,57 @@
+# Copyright (C) 2026 qfield-dev-tools Contributors.
+#
+#
+# This file is part of qfield-dev-tools.
+#
+# qfield-dev-tools is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 of the License, or
+# (at your option) any later version.
+#
+# qfield-dev-tools is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with qfield-dev-tools.  If not, see <https://www.gnu.org/licenses/>.
+
+"""QField AppImages and QField and QFieldCloud sources, kept in one cache."""
+
+from qfield_fetch.cache import (
+    CACHE_ENV,
+    LATEST,
+    QFIELD,
+    QFIELDCLOUD,
+    Entry,
+    FetchError,
+    Kind,
+    appimage,
+    default_cache_dir,
+    entries,
+    entry_path,
+    latest_release,
+    qfield_source,
+    qfieldcloud_source,
+    release_version,
+    remove,
+)
+
+__all__ = [
+    "CACHE_ENV",
+    "LATEST",
+    "QFIELD",
+    "QFIELDCLOUD",
+    "Entry",
+    "FetchError",
+    "Kind",
+    "appimage",
+    "default_cache_dir",
+    "entries",
+    "entry_path",
+    "latest_release",
+    "qfield_source",
+    "qfieldcloud_source",
+    "release_version",
+    "remove",
+]

qfield_fetch-0.1.0/src/qfield_fetch/__main__.py

@@ -0,0 +1,21 @@
+# Copyright (C) 2026 qfield-dev-tools Contributors.
+#
+#
+# This file is part of qfield-dev-tools.
+#
+# qfield-dev-tools is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 of the License, or
+# (at your option) any later version.
+#
+# qfield-dev-tools is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with qfield-dev-tools.  If not, see <https://www.gnu.org/licenses/>.
+
+from qfield_fetch.cli import app
+
+app(prog_name="qfield-fetch")

qfield_fetch-0.1.0/src/qfield_fetch/cache.py

@@ -0,0 +1,284 @@
+# Copyright (C) 2026 qfield-dev-tools Contributors.
+#
+#
+# This file is part of qfield-dev-tools.
+#
+# qfield-dev-tools is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 of the License, or
+# (at your option) any later version.
+#
+# qfield-dev-tools is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with qfield-dev-tools.  If not, see <https://www.gnu.org/licenses/>.
+
+"""Downloads kept in one cache, each fetched once even by parallel processes.
+
+An entry is complete once its directory exists. It is built in a temporary
+directory next to it and renamed into place while holding a file lock.
+"""
+
+from __future__ import annotations
+
+import fcntl
+import hashlib
+import json
+import logging
+import os
+import re
+import shutil
+import subprocess
+import tempfile
+from contextlib import contextmanager
+from dataclasses import dataclass
+from enum import StrEnum
+from functools import partial
+from pathlib import Path
+from typing import TYPE_CHECKING, Any
+from urllib.request import Request, urlopen
+
+if TYPE_CHECKING:
+    from collections.abc import Callable, Iterator
+
+LOGGER = logging.getLogger(__name__)
+
+CACHE_ENV = "QFIELD_FETCH_CACHE_DIR"
+GITHUB = "https://github.com"
+GITHUB_API = "https://api.github.com"
+QFIELD = "opengisch/QField"
+QFIELDCLOUD = "opengisch/QFieldCloud"
+LATEST = "latest"
+DOWNLOAD_CHUNK = 1 << 20
+VERSION_PATTERN = re.compile(r"v?(\d+\.\d+\.\d+[A-Za-z0-9.-]*)")
+# Refs name cache directories, so nothing that could leave the cache.
+REF_PATTERN = re.compile(r"[A-Za-z0-9][A-Za-z0-9._/-]*")
+
+
+class FetchError(RuntimeError):
+    """A download or clone failed."""
+
+
+class Kind(StrEnum):
+    APPIMAGE = "appimage"
+    SOURCE = "source"
+    QFIELDCLOUD = "qfieldcloud"
+
+
+@dataclass(frozen=True)
+class Entry:
+    kind: Kind
+    name: str
+    path: Path
+
+
+def default_cache_dir() -> Path:
+    """Return `$QFIELD_FETCH_CACHE_DIR`, or `qfield-fetch` in the user cache."""
+    configured = os.environ.get(CACHE_ENV)
+    if configured:
+        return Path(configured).expanduser().resolve()
+    base = os.environ.get("XDG_CACHE_HOME") or Path.home() / ".cache"
+    return Path(base) / "qfield-fetch"
+
+
+def _github_api(path: str) -> dict[str, Any]:
+    headers = {"Accept": "application/vnd.github+json"}
+    # Anonymous calls are limited to 60 an hour, CI runners share that.
+    if token := os.environ.get("GITHUB_TOKEN"):
+        headers["Authorization"] = f"Bearer {token}"
+    request = Request(f"{GITHUB_API}{path}", headers=headers)  # noqa: S310 GitHub API URL
+    with urlopen(request, timeout=30) as response:  # noqa: S310 GitHub API URL
+        return json.load(response)
+
+
+def latest_release(repository: str) -> str:
+    """Return the tag of the newest release, `v4.2.9` for example."""
+    return str(_github_api(f"/repos/{repository}/releases/latest")["tag_name"])
+
+
+def _asset_digest(version: str, name: str) -> str | None:
+    """Return the SHA-256 GitHub lists for a release asset, if it lists one."""
+    try:
+        release = _github_api(f"/repos/{QFIELD}/releases/tags/v{version}")
+    except OSError as error:
+        LOGGER.warning("Not verifying %s, its release is unavailable: %s", name, error)
+        return None
+    for asset in release.get("assets", []):
+        digest = str(asset.get("digest") or "")
+        if asset.get("name") == name and digest.startswith("sha256:"):
+            return digest.removeprefix("sha256:")
+    LOGGER.warning("Not verifying %s, its release lists no digest", name)
+    return None
+
+
+def release_version(version: str) -> str:
+    """Return the QField release `4.2.9` for `4.2.9`, `v4.2.9` or `latest`."""
+    if version == LATEST:
+        version = latest_release(QFIELD)
+    match = VERSION_PATTERN.fullmatch(version)
+    if not match:
+        msg = f"Not a QField release version: {version!r}"
+        raise ValueError(msg)
+    return match[1]
+
+
+def appimage(version: str, cache_dir: Path | None = None) -> Path:
+    """Download and extract a QField release AppImage once, and return its `AppRun`.
+
+    :param version: A release such as `4.2.9`, or `latest`
+    """
+    version = release_version(version)
+    target = _entry_path(Kind.APPIMAGE, version, cache_dir)
+    _ensure(target, partial(_install_appimage, version), update=False)
+    return target / "AppRun"
+
+
+def qfield_source(
+    ref: str, cache_dir: Path | None = None, *, update: bool = False
+) -> Path:
+    """Clone QField at one ref only, and return the checkout.
+
+    :param ref: A release such as `4.2.9`, `latest`, a tag or a branch
+    :param update: Clone again, for a branch that moved
+    """
+    ref = _git_ref(ref, QFIELD)
+    if match := VERSION_PATTERN.fullmatch(ref):
+        ref = f"v{match[1]}"
+    target = _entry_path(Kind.SOURCE, ref, cache_dir)
+    return _ensure(target, partial(_clone, QFIELD, ref), update=update)
+
+
+def qfieldcloud_source(
+    ref: str, cache_dir: Path | None = None, *, update: bool = False
+) -> Path:
+    """Clone QFieldCloud at one ref only, and return the checkout.
+
+    :param ref: A tag such as `v26.30`, `latest` or a branch
+    :param update: Clone again, for a branch that moved
+    """
+    ref = _git_ref(ref, QFIELDCLOUD)
+    target = _entry_path(Kind.QFIELDCLOUD, ref, cache_dir)
+    return _ensure(target, partial(_clone, QFIELDCLOUD, ref), update=update)
+
+
+def entries(cache_dir: Path | None = None) -> list[Entry]:
+    root = cache_dir or default_cache_dir()
+    return [
+        Entry(kind, path.name, path)
+        for kind in Kind
+        for path in sorted((root / kind).glob("[!.]*"))
+        if path.is_dir()
+    ]
+
+
+def entry_path(kind: Kind, name: str, cache_dir: Path | None = None) -> Path:
+    """Return where an entry is kept, fetched or not.
+
+    :param name: A release version or resolved ref, as `entries` names them
+    """
+    return _entry_path(Kind(kind), _checked_ref(name), cache_dir)
+
+
+def remove(kind: Kind, name: str, cache_dir: Path | None = None) -> bool:
+    """Remove one entry, and return whether it existed."""
+    target = entry_path(kind, name, cache_dir)
+    if not target.exists():
+        return False
+    with _locked(target):
+        shutil.rmtree(target)
+    return True
+
+
+def _git_ref(ref: str, repository: str) -> str:
+    if ref == LATEST:
+        return latest_release(repository)
+    return _checked_ref(ref)
+
+
+def _checked_ref(ref: str) -> str:
+    if not REF_PATTERN.fullmatch(ref) or ".." in ref:
+        msg = f"Not a release or git ref: {ref!r}"
+        raise ValueError(msg)
+    return ref
+
+
+def _entry_path(kind: Kind, name: str, cache_dir: Path | None) -> Path:
+    return (cache_dir or default_cache_dir()) / kind / name.replace("/", "_")
+
+
+@contextmanager
+def _locked(target: Path) -> Iterator[None]:
+    target.parent.mkdir(parents=True, exist_ok=True)
+    with target.with_name(f".{target.name}.lock").open("w") as lock:
+        fcntl.flock(lock, fcntl.LOCK_EX)
+        yield
+
+
+def _ensure(target: Path, install: Callable[[Path], None], *, update: bool) -> Path:
+    """Build the entry with `install` unless it exists, and return it."""
+    if target.exists() and not update:
+        return target
+    with _locked(target):
+        if target.exists() and not update:
+            return target
+        # Holding the lock, so these are left by killed processes.
+        for leftover in target.parent.glob(f".{target.name}-*"):
+            shutil.rmtree(leftover, ignore_errors=True)
+        with tempfile.TemporaryDirectory(
+            prefix=f".{target.name}-", dir=target.parent
+        ) as work_dir:
+            work = Path(work_dir)
+            install(work / "new")
+            if target.exists():
+                target.rename(work / "old")
+            (work / "new").rename(target)
+    return target
+
+
+def _run(*args: str, cwd: Path | None = None) -> None:
+    completed = subprocess.run(  # noqa: S603 fixed commands, refs are checked
+        args, cwd=cwd, check=False, capture_output=True, text=True
+    )
+    if completed.returncode:
+        msg = f"{' '.join(args)} failed:\n{completed.stderr[-3000:]}"
+        raise FetchError(msg)
+
+
+def _install_appimage(version: str, target: Path) -> None:
+    name = f"qfield-v{version}-linux-x64.AppImage"
+    image = target.parent / name
+    LOGGER.info("Downloading %s", name)
+    url = f"{GITHUB}/{QFIELD}/releases/download/v{version}/{name}"
+    sha256 = hashlib.sha256()
+    try:
+        with (
+            urlopen(url, timeout=60) as response,  # noqa: S310 GitHub release URL
+            image.open("wb") as out,
+        ):
+            while chunk := response.read(DOWNLOAD_CHUNK):
+                sha256.update(chunk)
+                out.write(chunk)
+    except OSError as error:
+        msg = f"Downloading {url} failed: {error}"
+        raise FetchError(msg) from error
+    expected = _asset_digest(version, name)
+    if expected and sha256.hexdigest() != expected:
+        msg = f"{name} does not match the SHA-256 of its release"
+        raise FetchError(msg)
+    image.chmod(0o755)
+    # Extracting avoids FUSE, which containers and CI runners often lack.
+    _run(str(image), "--appimage-extract", cwd=target.parent)
+    (target.parent / "squashfs-root").rename(target)
+
+
+def _clone(repository: str, ref: str, target: Path) -> None:
+    LOGGER.info("Cloning %s at %s", repository, ref)
+    _run(
+        *("git", "-c", "advice.detachedHead=false", "clone", "--quiet"),
+        *("--depth=1", f"--branch={ref}"),
+        f"{GITHUB}/{repository}.git",
+        str(target),
+    )

qfield_fetch-0.1.0/src/qfield_fetch/cli.py

@@ -0,0 +1,119 @@
+# Copyright (C) 2026 qfield-dev-tools Contributors.
+#
+#
+# This file is part of qfield-dev-tools.
+#
+# qfield-dev-tools is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 of the License, or
+# (at your option) any later version.
+#
+# qfield-dev-tools is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with qfield-dev-tools.  If not, see <https://www.gnu.org/licenses/>.
+
+"""The `qfield-fetch` command."""
+
+from __future__ import annotations
+
+from pathlib import Path
+from typing import TYPE_CHECKING, Annotated
+
+import typer
+
+from qfield_fetch import cache
+
+if TYPE_CHECKING:
+    from collections.abc import Callable
+
+app = typer.Typer(
+    help="Download QField AppImages and QField and QFieldCloud sources into one cache.",
+    no_args_is_help=True,
+)
+
+CacheDir = Annotated[
+    Path | None,
+    typer.Option(
+        envvar=cache.CACHE_ENV,
+        help="Cache directory, ~/.cache/qfield-fetch by default.",
+        show_default=False,
+    ),
+]
+Update = Annotated[bool, typer.Option(help="Clone again, for a branch that moved.")]
+
+
+def _echo_result(fetch: Callable[[], object]) -> None:
+    try:
+        typer.echo(fetch())
+    except (ValueError, cache.FetchError) as error:
+        typer.echo(error, err=True)
+        raise typer.Exit(1) from error
+
+
+def _resolved(cache_dir: Path | None) -> Path | None:
+    return cache_dir.expanduser().resolve() if cache_dir else None
+
+
+@app.command()
+def appimage(
+    version: Annotated[str, typer.Argument(help="A release such as 4.2.9, or latest.")],
+    cache_dir: CacheDir = None,
+) -> None:
+    """Download and extract a QField AppImage, and print its AppRun."""
+    _echo_result(lambda: cache.appimage(version, _resolved(cache_dir)))
+
+
+@app.command()
+def source(
+    ref: Annotated[
+        str, typer.Argument(help="A release such as 4.2.9, latest, a tag or a branch.")
+    ],
+    *,
+    update: Update = False,
+    cache_dir: CacheDir = None,
+) -> None:
+    """Clone QField at one ref only, and print the checkout."""
+    _echo_result(lambda: cache.qfield_source(ref, _resolved(cache_dir), update=update))
+
+
+@app.command()
+def qfieldcloud(
+    ref: Annotated[
+        str, typer.Argument(help="A tag such as v26.30, latest or a branch.")
+    ],
+    *,
+    update: Update = False,
+    cache_dir: CacheDir = None,
+) -> None:
+    """Clone QFieldCloud at one ref only, and print the checkout."""
+    _echo_result(
+        lambda: cache.qfieldcloud_source(ref, _resolved(cache_dir), update=update)
+    )
+
+
+@app.command("list")
+def list_entries(cache_dir: CacheDir = None) -> None:
+    """List what the cache holds."""
+    for entry in cache.entries(_resolved(cache_dir)):
+        typer.echo(f"{entry.kind}\t{entry.name}\t{entry.path}")
+
+
+@app.command()
+def remove(
+    kind: Annotated[cache.Kind, typer.Argument(help="What to remove.")],
+    name: Annotated[str, typer.Argument(help="Name as `list` shows it.")],
+    cache_dir: CacheDir = None,
+) -> None:
+    """Remove one entry from the cache."""
+    try:
+        removed = cache.remove(kind, name, _resolved(cache_dir))
+    except ValueError as error:
+        typer.echo(error, err=True)
+        raise typer.Exit(1) from error
+    if not removed:
+        typer.echo(f"No {kind} {name}", err=True)
+        raise typer.Exit(1)

qfield_fetch-0.1.0/src/qfield_fetch/pytest_plugin.py

@@ -0,0 +1,69 @@
+# Copyright (C) 2026 qfield-dev-tools Contributors.
+#
+#
+# This file is part of qfield-dev-tools.
+#
+# qfield-dev-tools is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 2 of the License, or
+# (at your option) any later version.
+#
+# qfield-dev-tools is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with qfield-dev-tools.  If not, see <https://www.gnu.org/licenses/>.
+
+"""Pytest options that pytest-qfield and pytest-qfield-app share."""
+
+from __future__ import annotations
+
+import os
+from pathlib import Path
+
+import pytest
+
+from qfield_fetch.cache import CACHE_ENV, default_cache_dir
+
+VERSION_ENV = "QFIELD_VERSION"
+VERSION_KEY = "qfield_version"
+CACHE_KEY = "qfield_fetch_cache_dir"
+
+
+def pytest_addoption(parser: pytest.Parser) -> None:
+    group = parser.getgroup("qfield-fetch")
+    group.addoption(
+        "--qfield-version",
+        help=f"QField release or git ref to test against. Env {VERSION_ENV}.",
+    )
+    parser.addini(VERSION_KEY, "QField release or git ref to test against.")
+    parser.addini(
+        CACHE_KEY,
+        f"qfield-fetch cache, relative to the rootdir. Env {CACHE_ENV}.",
+    )
+
+
+def configured_version(config: pytest.Config) -> str | None:
+    """Return the QField version from the option, the env or the ini, in that order."""
+    return (
+        config.getoption(VERSION_KEY)
+        or os.environ.get(VERSION_ENV)
+        or config.getini(VERSION_KEY)
+        or None
+    )
+
+
+def configured_cache_dir(config: pytest.Config) -> Path:
+    """Return the cache from the env or the ini, or the user cache."""
+    configured = config.getini(CACHE_KEY)
+    if configured and not os.environ.get(CACHE_ENV):
+        return config.rootpath / Path(configured).expanduser()
+    return default_cache_dir()
+
+
+@pytest.fixture(scope="session")
+def qfield_fetch_cache_dir(pytestconfig: pytest.Config) -> Path:
+    """Where qfield-fetch keeps AppImages and sources."""
+    return configured_cache_dir(pytestconfig)