{"id":22353508,"url":"https://github.com/dp6/penguin-document-formatter","last_synced_at":"2025-07-30T08:34:12.092Z","repository":{"id":40238088,"uuid":"311679713","full_name":"DP6/penguin-document-formatter","owner":"DP6","description":"A document reader to extract Google Analytics planned events   to use on the Raft Suite Data Quality","archived":false,"fork":false,"pushed_at":"2022-12-07T03:33:11.000Z","size":961,"stargazers_count":7,"open_issues_count":10,"forks_count":2,"subscribers_count":24,"default_branch":"main","last_synced_at":"2024-11-28T23:32:29.573Z","etag":null,"topics":["analytics","data-quality","google-cloud","hacktoberfest","monitoring","pdf-converter"],"latest_commit_sha":null,"homepage":"https://dp6.github.io/penguin-document-formatter","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DP6.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-11-10T14:14:11.000Z","updated_at":"2022-03-28T21:19:29.000Z","dependencies_parsed_at":"2023-01-24T13:16:07.519Z","dependency_job_id":null,"html_url":"https://github.com/DP6/penguin-document-formatter","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DP6%2Fpenguin-document-formatter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DP6%2Fpenguin-document-formatter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DP6%2Fpenguin-document-formatter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DP6%2Fpenguin-document-formatter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DP6","download_url":"https://codeload.github.com/DP6/penguin-document-formatter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228114910,"owners_count":17871742,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["analytics","data-quality","google-cloud","hacktoberfest","monitoring","pdf-converter"],"created_at":"2024-12-04T13:08:50.378Z","updated_at":"2024-12-04T13:08:51.286Z","avatar_url":"https://github.com/DP6.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Document Formatter Penguin\n\n\u003cdiv align=\"center\"\u003e\n\u003cimg src=\"https://raw.githubusercontent.com/DP6/templates-centro-de-inovacoes/main/public/images/centro_de_inovacao_dp6.png\" height=\"100px\" /\u003e\n\u003c/div\u003e\n\n[![Build Status](https://travis-ci.org/DP6/penguin-document-formatter.svg?branch=main)](https://travis-ci.org/DP6/penguin-document-formatter)\n\nO penguin-document-formatter é um módulo do ecossistema raft-suite criado pela [DP6](https://www.dp6.com.br) para garantir a qualidade dos dados ([Data Quality](https://en.wikipedia.org/wiki/Data_quality)) nos projetos de engenharia de dados implementados nos clientes da DP6, através de monitoramento automatizados de dados.\n\n## Ecossistema raft-suite\n\nO penguin-datalayer-collect consegue auxiliar as áreas de digital analytics das empresas nos seguintes pilares da qualidade de dados:\n\n- Disponibilidade\n- Completude\n- Consistência\n\nO ecossistema raft-suite é uma solução da DP6 que visa suprir as necessidades de monitoria do ciclo de vida dos dados para antecipar possíveis inconsistências.\n\n## Dependências\n\nEste módulo utiliza a biblioteca pdf2json, além dos serviços Google Cloud Functions, Google Cloud Storage, Google Pub/Sub e Google BigQuery.\n\n## Executando localmente\n\nPara adaptar, faça alterações nos arquivos nas pastas `src` e `test`.\n\nPara executar localmente, basta copiar o mapa de coleta e executar o comando na raiz:\n\n```shell\nnode index.js [nome-do-arquivo]\n```\n\nNo nosso exemplo:\n\n```shell\nnode index.js sitedp6.pdf;\n```\n\nO arquivo index.js serve para executar todas as funções presentes nos outros arquivos. Para utilização de teestes as funções foram consolidadas no arquivo `local.js`.\n\n## Build\n\nApós o desenvolvimento, executar `gulp build` para estruturar o que será inserido nas cloud functions. Até o momento temos as seguintes:\n\n| Nome                | Função                                       | Status             |\n| ------------------- | -------------------------------------------- | ------------------ |\n| convert-pdf-to-json | Extrair o json estruturado dos pdfs e salvar | Em desenvolvimento |\n| extract-events      | Extrair eventos do mapa de coleta            | Em desenvolvimento |\n\n## Testes\n\nTestes ainda em desenvolvimento; para qualquer nova funcionalidade, adicione um novo arquivo de teste.\nOs testes são configurados pra funcionar com o modelo de mapa que está na raiz do projeto, e com as configurações `test_config.json`. Caso precise adaptar as funções para extrair mais ou menos informações, adicione condições para que a versão padrão continue funcionando, pois assim os testes podem garantir que o projeto continua sendo construído conforme esperado.\n\n## Suporte:\n\n**DP6 Koopa-troopa Team**\n\n_e-mail: \u003ckoopas@dp6.com.br\u003e_\n\n\u003cimg src=\"https://raw.githubusercontent.com/DP6/templates-centro-de-inovacoes/main/public/images/koopa.png\" height=\"100\" /\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdp6%2Fpenguin-document-formatter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdp6%2Fpenguin-document-formatter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdp6%2Fpenguin-document-formatter/lists"}