El SDK y el ILCI oficiales de QFieldCloud

qfieldcloud-sdk es el cliente oficial para conectarse a la API QFieldCloud ya sea como un módulo de python o directamente desde la línea de comandos.

Nota

qfieldcloud-sdk requiere Python >=3.6

Instalar¶

pip install qfieldcloud-sdk

Uso del módulo¶

import requests
from qfieldcloud_sdk import sdk

client = sdk.Client(
    url="https://app.qfield.cloud/api/v1/",
    username="user1",
    password="pass1",
)

try:
    projects = client.list_projects()
except requests.exceptions.RequestException:
    print("Oops!")

Uso ILC¶

La herramienta ILC oficial QFieldCloud

Uso¶

qfieldcloud-cli [OPTIONS] COMMAND [ARGS]...

Ejemplos¶

# inicia la sesión del usuario "user" con la contraseña "pass"
qfieldcloud-cli login user pass

# obtiene los proyectos del usuario "user" con contraseña "pass" en "https://localhost/api/v1/"
qfieldcloud-cli -u user -p pass -U https://localhost/api/v1/ list-projects

# obtiene los proyectos del usuario autenticado con el token `QFIELDCLOUD_TOKEN` en "https://localhost/api/v1/" como JSON
export QFIELDCLOUD_URL=https://localhost/api/v1/
export QFIELDCLOUD_TOKEN=017478ee2464440cb8d3e98080df5e5a
qfieldcloud-cli --json list-projects

Filtros¶

Algunos comandos permiten definir un filtro en los resultados basado en el nombre del archivo con la opción --filter (por ejemplo, el comando download-files ).

Los filtros admiten comodines de tipo shell de Unix. Los caracteres especiales utilizados en los comodines de estilo shell son:

Patrón	Significado
*	coincide con todo
?	coincide con cualquier carácter
[seq]	coincide con cualquier carácter en la secuencia
[!seq]	coincide con cualquier carácter en seq

coincide con cualquier carácter que no esté en la secuencia |

Para una coincidencia literal, envuelva los metacaracteres entre paréntesis. Por ejemplo, '[?]' coincide con el carácter '?'.

Ejemplos¶

qfieldcloud-cli --filter 'DCIM/*.jpg'
qfieldcloud-cli --filter 'attachments/documentation-??.pdf'

Resumen de opciones globales¶

-U, --url TEXT                  URL to the QFieldCloud API endpoint. If not
                                passed, gets the value from QFIELDCLOUD_URL
                                environment variable. Default:
                                https://app.qfield.cloud/api/v1/
-u, --username TEXT             Username or email.
-p, --password TEXT
-t, --token TEXT                Session token.
--json / --human                Output the result as newline formatted json. Default: False
--verify-ssl / --no-verify-ssl  Verify SSL. Default: True
--help                          Show this message and exit.

Se pueden utilizar variables de entorno en lugar de pasar algunas opciones globales comunes.

QFIELDCLOUD_API - URL del punto final de la API de QFieldCloud
QFIELDCLOUD_USERNAME - Nombre de usuario o correo electrónico de QFieldCloud. Requiere que se establezca QFIELDCLOUD_PASSWORD.
QFIELDCLOUD_PASSWORD - Contraseña. Requiere que se defina QFIELDCLOUD_USERNAME.
QFIELDCLOUD_TOKEN - Token que se puede utilizar en lugar de pasar el nombre de usuario y la contraseña. Se puede obtener ejecutando qfieldcloud-cli login.
QFIELDCLOUD_VERIFY_SSL - Cuando se define como 0 tiene el mismo efecto que pasar --no-verify-ssl.

Vista general de comandos¶

  login             Login to QFieldCloud.
  logout            Logout and expire the token.
  list-projects     List QFieldCloud projects.
  list-files        List QFieldCloud project files.
  create-project    Creates a new empty QFieldCloud project.
  delete-project    Deletes a QFieldCloud project.
  upload-files      Upload files to a QFieldCloud project.
  download-files    Download QFieldCloud project files.
  delete-files      Delete QFieldCloud project files.
  list-jobs         List project jobs.
  job-trigger       Triggers a new job.
  job-status        Get job status.
  package-latest    Check project packaging status.
  package-download  Download packaged QFieldCloud project files.

inicio de sesión¶

Inicio de sesión en QFieldCloud.

qfieldcloud-cli login [OPCIONES] NOMBREUSUARIO CONTRASEÑA

cierre de sesión¶

Cierre de sesión de QFieldCloud.

qfieldcloud-cli logout

listado-proyectos¶

Listar proyectos QFieldCloud.

qfieldcloud-cli list-projects [OPTIONS]

Options:
  --include-public / --no-public  Includes the public project in the list. Default: False

listado-ficheros¶

Listar los archivos del proyecto QFieldCloud.

qfieldcloud-cli list-files [OPCIONES] ID_PROYECTO```

#### create-project

Crea un nuevo proyecto QFieldCloud vacío.

```bash
qfieldcloud-cli create-project [OPTIONS] NAME

Options:
  --owner TEXT                Owner of the project. If omitted, the current
                              user is the owner.
  --description TEXT          Description of the project.
  --is-public / --is-private  Mark the project as public.

delete-project¶

Eliminar un proyecto QFieldCloud.

qfieldcloud-cli delete-project [OPTIONS] PROJECT_ID

upload-files¶

Subir archivos a un proyecto de QFieldCloud.

qfieldcloud-cli upload-files [OPTIONS] PROJECT_ID PROJECT_PATH

Options:
  --filter TEXT                   Do not upload the whole project, but only
                                  the files which match the glob.
  --throw-on-error / --no-throw-on-error
                                  If any project file upload fails stop
                                  uploading the rest. Default: False

download-files¶

Descargar los archivos del proyecto QFieldCloud.

qfieldcloud-cli download-files [OPTIONS] PROJECT_ID LOCAL_DIR

Options:
  --filter TEXT                   Do not download the whole project, but only
                                  the files which match the glob.
  --throw-on-error / --no-throw-on-error
                                  If any project file downloads fails stop
                                  downloading the rest. Default: False
  --force-download/--no-force-download
                                 Download file even if it already exists locally.
                                  Default: False

delete-files¶

Eliminar los archivos del proyecto QFieldCloud.

qfieldcloud-cli delete-files [OPTIONS] PROJECT_ID PATHS...

Options:
  --throw-on-error / --no-throw-on-error
                                  If any project file delete operations fails
                                  stop, stop deleting the rest. Default: False

job-list¶

Listar los trabajos del proyecto.

qfieldcloud-cli list-jobs [OPTIONS] PROJECT_ID

Options:
  --type JOBTYPES  Job type. One of package, delta_apply or
                   process_projectfile.

job-trigger¶

Activa un nuevo trabajo.

qfieldcloud-cli job-trigger [OPTIONS] PROJECT_ID JOB_TYPE

Options:
  --force / --no-force  Should force creating a new job. Default: False

job-status¶

Obtener el estado del trabajo.

qfieldcloud-cli job-status [OPTIONS] JOB_ID

package-latest¶

Compruebe el estado del empaquetado del proyecto.

qfieldcloud-cli package-latest [OPTIONS] PROJECT_ID

package-download¶

Descargue los archivos del proyecto QFieldCloud empaquetados.

qfieldcloud-cli package-download [OPTIONS] PROJECT_ID LOCAL_DIR

Options:
  --filter TEXT                   Do not download the whole packaged project,
                                  but only the files which match the glob.
  --throw-on-error / --no-throw-on-error
                                  If any packaged file downloads fails stop
                                  downloading the rest. Default: False
  --force-download/--no-force-download
                                 Download file even if it already exists locally.
                                  Default: False