Skip to content

bymatheus/wakatime-readme

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

wakatime-readme

WakaTime Metricas semanais do Wakatime no README do seu perfil.
Inspirado no projeto feito em Python do Athul.


Suas métricas atualizadas diariamente.

Este script usa a API do WAKATIME para atualizar seu readme diariamente com suas métricas de desenvolvimento.


Como funciona

1. Wakatime

Você precisa criar uma conta no wakatime
Clique aqui para cria-la.

2. Download

Clone ou baixe este projeto e cole dentro do repositório do seu perfil <nickname/nickname>.

3. Customizando o readme com seus dados

  • Dentro da estrutura do projeto você vai entrar o diretorio markdown;
  • No diretório, você vai encontrar dois arquivos .md;
  • TOP.md e BOTTOM.md.

  • O seu README.md vai ser separado em três partes;
  • O TOP.md, responsável pela parte de cima do seu README;
  • O meio, criado com as métricas do WAKATIME;
  • E o BOTTOM.md, finalizando o arquivo README.md.

Ambos arquivos dentro do diretório MARKDOWN foram criados para você customizar o seu README.md

Lembre-se de não editar o README.md que se encontra na raiz do repositório, todo o conteúdo será deletado a cada atualização e sobreposto com os dados do ./markdown/TOP e ./markdown/BOTTOM

4. Inserindo seu nick no WAKATIME

  • No arquivo cron.php você vai encontrar um objeto sendo instânciado e um atributo sendo enviado como parâmetro para o construtor do objeto;
  • Esse atributo se trata do NICKNAME do WAKATIME;
  • Você precisa alterar o atributo para seu NICKNAME do WAKATIME.
use MplusC\WakatimeReadme\SearchEngine;

require 'vendor/autoload.php';

$search = new SearchEngine('@SeuNickname');
$search->process();

5. Commitando

Você pode escolher entre commitar o README já atualizado ou esperar que a action do GitHub o faça.

Caso queira enviar atualizado, você precisa ter o PHP 8 e o COMPOSER instalados na sua maquina, e rodar os seguintes comandos no terminal.

composer update
composer semanal-update 

Caso queira aguardar o cron job ser rodado

git add .
git commit -m "Sua mensagem de commit"
git push origin main

O cron job está agendado para rodar todos os dias as 21:30 UTC (00:30 CET-3)

Alterando o cron job

Caso queira editar a action:

  • Na pasta .github/workflows você encontrará o arquivo php.yml
  • Basta alterar a hora que gostaria que o cron fosse rodado
  • Auxilio para criar um cron job
name: PHP Composer

on:
  workflow_dispatch:
  schedule:
    - cron: "5 21 * * *"

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2

      - name: Update composer
        run: composer update

      - name: Update stats
        run: composer semanal-update

Pronto, seu readme sempre atualizado com suas métricas, essas são as minhas:


💡 Editor

💬 Linguagem

💻 Sistema Operacional

📦 Categoria