metabrainz.org

Site da Fundação Metabrainz. Este é um aplicativo da Web baseado em frascos que fornece informações sobre a fundação e seus apoiadores, aceita doações de usuários e organizações e fornece acesso aos pacotes de replicação para o MusicBrainz.

Fazendo um lançamento

Como outros Pythonbrainz, esse repositório também possui as ações do GitHub para ajudar a fazer uma liberação. Uma imagem do Docker é construída e empurrada para o Docker Hub sempre que uma liberação é feita do GitHub. A seguir estão as etapas para fazer um lançamento:

1. Navegue até a página de lançamentos. Mais informações sobre lançamentos estão disponíveis aqui.
2. Você deve ver uma liberação Draft no topo. Clique no botão Edit ao lado.
3. No campo Tag Version , digite a tag com a qual deseja o docker. Por exemplo, se você inserir v-2021-06-08.0 como a tag, a imagem do docker correspondente será metabrainz/metabrainz:v-2021-06-08.0 .
4. Clique no Publish release .

Observação:

1. O status da construção pode ser verificado na página Ações.
2. O campo de título de liberação é ignorado pela ação. Pode ser definido como qualquer valor que desejar. Geralmente o definimos para a etiqueta dessa versão.
3. A descrição da versão é atualizada apenas com títulos de PRs mesclados não cometidos pressionados diretamente ao Master.

Configuração de desenvolvimento

A maneira mais fácil de configurar o site da Metabrainz para o desenvolvimento é usar o Docker. Verifique se ele está instalado em sua máquina antes de seguir as instruções.

Configuração

A configuração do aplicativo deve ser armazenada no arquivo chamado config.py . Você pode usar um exemplo um ( config.py.example ) e ajustar a configuração:

 $ cp config.py.example config.py
$ vim config.py

Você precisa garantir que as variáveis ​​necessárias estejam definidas.

MusicBrainz Oauth

Para permitir que os usuários efetuem login, você precisará definir duas teclas: MUSICBRAINZ_CLIENT_ID e MUSICBRAINZ_CLIENT_SECRET . Para obter essas chaves, você precisa registrar sua instância de metabrainz.org no musicbrainz em https://musicbrainz.org/account/applications/register. Defina o campo URL de retorno de chamada para http://<your host>/login/musicbrainz/post (se PREFERRED_URL_SCHEME no arquivo de configuração estiver definido como https , verifique se você especifica o mesmo protocolo para URL de chamada). Se você executar o servidor localmente, substitua <your host> pelo localhost .

Pagamentos

Em seguida, é a configuração dos sistemas de pagamento. Usamos o PayPal e o Stripe para aceitar pagamentos à nossa fundação. O dicionário PayPal_Account_Ids contém IDs PayPal ou endereços de email de contas para cada moeda suportada. PayPal_business é um endereço para não doações; Todos os pagamentos enviados para lá serão ignorados.

Depois que essas configurações foram definidas e você tem certeza de que sua configuração está funcionando corretamente no modo de teste, você pode girar a chave. Defina a depuração como False e PAPLEY_PRODUÇÃO como True . AVISO! Para fins de desenvolvimento, você deve usar apenas pagamentos no modo de depuração.

Servindo pacotes de replicação

Os pacotes de replicação devem ser copiados no diretório ./data/replication_packets . Deve ter a seguinte estrutura:

 ./data/replication_packets/
    - hourly replication packets

Comece

Este comando criará e iniciará todos os serviços que você poderá usar para o desenvolvimento:

 $ ./develop.sh

Na primeira vez em que você configura o aplicativo, o banco de dados precisa ser inicializado:

 $ ./develop.sh manage init-db --create-db

O servidor da web agora deve estar acessível em http: // localhost: 80/ .

Folhas de estilo de construção

Devido à maneira como o ambiente de desenvolvimento funciona com o Docker, é necessário construir CSS separadamente da construção de uma imagem. Para fazer isso, você precisa iniciar o servidor de desenvolvimento (todos os contêineres com composição do Docker) e anexar ao contêiner web :

$ ./develop.sh exec -it web bash

Em seguida, instale os módulos NPM e construa CSS:

web# npm install
web# ./node_modules/.bin/lessc ./metabrainz/static/css/main.less > ./metabrainz/static/css/main.css
web# ./node_modules/.bin/lessc ./metabrainz/static/css/theme/boostrap/boostrap.less > ./metabrainz/static/css/theme/boostrap/boostrap.css
web# ./node_modules/.bin/lessc ./metabrainz/static/fonts/font_awesome/less/font-awesome.less > ./metabrainz/static/fonts/font_awesome/less/font-awesome.css

As duas últimas compilações são necessárias apenas se você planeja usar a interface de administrador.

Traduções

Extraindo cordas

Depois de construir e iniciar todos os serviços, conforme mencionado acima, execute:

$ ./develop.sh manage extract-strings

Compilando as cordas

Os arquivos de maconha são compilados automaticamente sempre que os serviços são construídos, mas, caso você faça alterações nos arquivos de maconha e deseja compilar os arquivos de tradução novamente, execute:

$ ./develop.sh manage compile-translations

Teste

Para executar todos os testes, use:

 $ ./test.sh

Testando pagamentos

Antes de fazer qualquer coisa, certifique -se de que a variável PAYMENT_PRODUCTION no arquivo de configuração esteja definida como False ! Dessa forma, você usará ambientes de teste em que cartões de crédito e contas bancárias não são realmente cobradas. Mais informações sobre os ambientes de teste para cada serviço de pagamento podem ser encontrados em sua documentação:

• PayPal: https://developer.paypal.com/webapps/developer/docs/
• Stripe: https://stripe.com/docs/testing

Observe que, para que o IPNS funcione, o aplicativo deve estar disponível publicamente. Se você estiver fazendo desenvolvimento em sua máquina local, é provável que seus pontos de extremidade de retorno de chamada não sejam acessíveis para os processadores de pagamento.