Bem-vindo ao qualis-zotero!

Documentação da API

Este módulo oferece funções para processar artigos da biblioteca Zotero, atribuindo estratos Qualis com base em uma planilha CSV e buscando ISSNs ausentes via OpenAlex.

Funções principais

  • processar: processa os itens da coleção do Zotero e atribui estrato Qualis.

  • load_config: carrega o arquivo de configuração YAML.

Zotero

  • get_items: obtém os itens de uma coleção do Zotero.

  • update_item: atualiza o ISSN e Qualis no Zotero.

Qualis

OpenAlex

  • buscar_issn: busca o ISSN via OpenAlex usando DOI ou título.

Funções principais

qualis_zotero.core.processar(zotero_api_key, zotero_group_id, collection_key, qualis_csv_path, **kwargs)[código-fonte]

Processa os itens de uma coleção do Zotero, atualizando o campo ISSN (se necessário) e atribuindo a classificação Qualis com base em uma base de dados CSV.

A função realiza as seguintes etapas: 1. Busca os itens da coleção especificada no grupo Zotero. 2. Verifica se o campo ISSN está presente. Caso não esteja, tenta obtê-lo via API do OpenAlex. 3. Com o ISSN, consulta a base Qualis para obter o estrato da publicação. 4. Se o ISSN não estiver na base, realiza uma correspondência fuzzy com o nome da revista. 5. Atualiza os dados no Zotero com o ISSN e a classificação Qualis, quando aplicável. 6. Exibe um resumo da execução, incluindo número de correspondências via OpenAlex e Fuzzy Matching.

Parâmetros:
  • zotero_api_key (str) – Chave de API do Zotero com permissões de leitura/escrita.

  • zotero_group_id (str) – ID do grupo Zotero onde os itens estão armazenados.

  • collection_key (str) – Chave da coleção Zotero a ser processada.

  • qualis_csv_path (str) – Caminho para o arquivo CSV contendo os dados do Qualis (com colunas ‘ISSN’, ‘Estrato’ e ‘Publicação’).

Retorna:

Nenhum valor é retornado. Os dados são atualizados diretamente no Zotero, e um relatório é impresso no console.

Tipo de retorno:

None

qualis_zotero.config.load_config(path='config.yaml')[código-fonte]

Carrega configurações do arquivo YAML.

Parâmetros:

path (str) – Caminho para o arquivo YAML de configuração.

Retorna:

Dicionário com as configurações carregadas.

Tipo de retorno:

dict

Zotero

qualis_zotero.zotero.get_items(api_key, group_id, collection_key)[código-fonte]

Obtém os itens da coleção Zotero.

Parâmetros:
  • api_key (str) – Chave da API Zotero.

  • group_id (str) – ID do grupo Zotero.

  • collection_key (str) – Chave da coleção Zotero.

Retorna:

Lista de itens JSON da coleção.

Tipo de retorno:

list

qualis_zotero.zotero.update_item(api_key, group_id, item_key, issn, qualis)[código-fonte]

Atualiza o ISSN e a classificação Qualis de um item no Zotero.

Parâmetros:
  • api_key (str) – Chave da API Zotero.

  • group_id (str) – ID do grupo Zotero.

  • item_key (str) – Chave do item Zotero.

  • issn (str) – ISSN para atualizar.

  • qualis (str) – Estrato Qualis para atualizar.

Retorna:

True se a atualização foi bem-sucedida, False caso contrário.

Tipo de retorno:

bool

Prints mensagens informativas sobre as atualizações realizadas.

Qualis

qualis_zotero.qualis.carregar_base_qualis(caminho_csv)[código-fonte]

Carrega a base Qualis do arquivo CSV.

Parâmetros:

caminho_csv (str) – Caminho para o arquivo CSV da base Qualis.

Retorna:

dict: Mapeamento ISSN -> estrato Qualis dict: Mapeamento nome da revista (minúsculo) -> estrato Qualis

Tipo de retorno:

tuple

OpenAlex

qualis_zotero.openalex.buscar_issn(titulo, doi=None)[código-fonte]

Busca o(s) ISSN de um artigo com base no título e/ou DOI usando a API OpenAlex.

Parâmetros:
  • title (str) – Título do artigo.

  • doi (str) – DOI do artigo.

Retorna:

Lista de ISSNs encontrados (sem hífen).

Tipo de retorno:

list[str]