Gaffer

Capataz

Para obtener acceso rápido y fácil a un entorno con todo instalado y configurado correctamente, puede usar GitHub Codespaces o, alternativamente, GitLab GitPod. Estos proporcionan entornos de codificación remota utilizando VS Code con los complementos necesarios, la versión de Java y Maven preinstalado.

Nuestro Javadoc se puede encontrar aquí. La documentación de Gaffer se guarda en el repositorio gaffer-doc y se publica en las páginas de GitHub (gchq.github.io).

Requisitos locales

Para compilar Gaffer localmente necesita Java 8 u 11 y Maven instalado localmente en un entorno *nix. MS Windows funcionará para la mayoría de los propósitos, pero no se recomienda porque las pruebas que utilizan Hadoop fallan debido a la compatibilidad limitada de Hadoop en Windows. Gaffer compilará con versiones más nuevas de Java, pero algunas pruebas fallarán debido a la falta de soporte para Java más nuevo en ciertas dependencias externas.

Para compilar Gaffer, ejecute mvn clean install -Pquick en el directorio de nivel superior. Esto creará todas las bibliotecas principales de Gaffer y algunos ejemplos de cómo cargar y consultar datos.

Proceso de contribución

Puede encontrar información detallada sobre nuestras formas de trabajar en nuestros documentos para desarrolladores. En resumen:

• Firme el Acuerdo de licencia de colaborador de GCHQ
• Empuje sus cambios a una bifurcación
• Enviar una solicitud de extracción

Inclusión en otros proyectos

Gaffer está alojado en Maven Central y puede incorporarse fácilmente a sus propios proyectos de Maven.

Para usar Gaffer desde la API de Java, las únicas dependencias requeridas son el módulo gráfico Gaffer y un módulo de tienda para la tecnología de base de datos específica utilizada para almacenar los datos, por ejemplo, para la tienda Accumulo:

< dependency >
    < groupId >uk.gov.gchq.gaffer</ groupId >
    < artifactId >graph</ artifactId >
    < version >${gaffer.version}</ version >
</ dependency >
< dependency >
    < groupId >uk.gov.gchq.gaffer</ groupId >
    < artifactId >accumulo-store</ artifactId >
    < version >${gaffer.version}</ version >
</ dependency >

Esto incluirá todas las demás dependencias obligatorias. Se pueden agregar otros componentes (opcionales) a su proyecto según sea necesario.

Repositorios relacionados

El repositorio gafferpy contiene un shell de Python que puede ejecutar operaciones.

El repositorio gaffer-docker contiene el código necesario para ejecutar Gaffer usando Docker o Kubernetes.

El repositorio koryphe contiene una biblioteca de funciones extensible para filtrar, agregar y transformar datos basados ​​en la API de funciones de Java. Es una dependencia de Gaffer.

Licencia

Gaffer tiene la licencia Apache 2 y está cubierto por Crown Copyright.

 Copyright 2016-2023 Crown Copyright

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.