Skip to content

Latest commit

 

History

History
71 lines (46 loc) · 3.51 KB

README.md

File metadata and controls

71 lines (46 loc) · 3.51 KB
Raw

DOI Manager

É uma ferramenta desenvolvida para automatizar os registros de DOI pelas coleções que adotam a métodologia SciELO. Por meio do DOI Manager é possível gerenciar novos depósitos, re-depositar, contabilizar custos e buscar informações sobre sucesso e falha de depósitos passados.

Documentação

Para mais informações sobre a ferramenta acesse o índice da documentação.

Métodos de instalação

Os tópicos a seguir cobrem os requisitos básicos para a instalação da aplicação.

Variáveis de ambiente

Configurar as variáveis de ambiente é um pré requisito para utilizar o DOI Manager. Os dados de configuração podem variar de acordo com o tipo de instalação, ambiente utilizado, sistema operacional, etc. Consulte a pessoa responsável pelo ambiente de deploy para obter mais detalhes.

As seguintes variáveis devem ser configuradas:

  • ARTICLEMETA_ADMINTOKEN - Token utilizado para conectar ao ArticleMeta;
  • ARTICLEMETA_THRIFTSERVER - Endereço do servidor thrift do ArticleMeta;
  • COLLECTION_ACRONYM - Acrônimo da coleção em que o DOI Manager irá rodar;
  • CROSSREF_API_PASSWORD - Senha da API do Crossref
  • CROSSREF_API_USER - Usuário da API do Crossref;
  • CROSSREF_DEPOSITOR_EMAIL - E-mail utilizado pelo depositor do DOI no Crossref;
  • CROSSREF_DEPOSITOR_NAME - Nome utilizado pelo depositor do DOI no Crossref;
  • CROSSREF_PREFIX - Prefixo utilizado pelo depositor do DOI no Crossref (ex: a SciELO utiliza o 10.1590);
  • SQL_ENGINE - URI utilizada para conectar ao Banco de dados (PostgreSQL) (ex: postgresql://usuario:senha@db:5432/banco_de_dados);
  • LOGGING_LEVEL - Nível de log utilizado pela aplicação;

Instalação direta

Para realizar uma instalação direta, sem auxílio de containers, deve-se atentar para os seguintes pré requisitos:

  • Python 3.5.2
  • Libxml2 dev
  • PostgreSQL 9.5
  • Celery 4.2.1
  • Redis >= 4.0 <= 5.0
  • Musl dev

Faça o download da aplicação, desempacote o código e execute o comando:

pip install -r requirements.txt

Faça uma cópia dos arquivos de inicialização e configure as variáveis necessárias ao seu ambiente:

cp production.ini-TEMPLATE config.ini
cp alembic.ini-TEMPLATE alembic.ini

Instalação via imagem Docker

É possível usar o docker-compose para facilitar a instalação do ambiente via Docker, utilize o comando:

docker-compose up

O build das imagens será realizado e o ambiente deve ser inicialiado de acordo com o processo definido no arquivo docker-compose.yml.

Métodos de operação

O DOI Manager não é auto suficiente ao depositar os registros DOI, é necessário a intervenção humana para inicializar o processo de registro. Após instalação do DOI Manager o Comando processing_export_doi estará disponível a partir da linha de comando, para mais opções execute o comando processing_export_doi --help.

Ao configurar o ambiente de deploy da aplicação é recomendável que se configure agendadores de execução para o comando processing_export_doi.

ATENÇÃO ⚠️ O DOI Manager é dependente dos dados vindos do ArticleMeta, a execução do comando processing_export_doi só deverá acontecer após o ArticleMeta estar ATUALIZADO. Para mais detalhes sobre datas e horários de atualização consulte a pessoa responsável pela infraestrutura.