Publicando Projetos do Google Colab no Github
Olá!
Estes dias estava conversando com a turma de DataScience que estou participando e surgiu algumas dúvidas relacionadas a publicação de projetos no GitHub. Muitos não possuem vivência ou nunca utilizaram estas ferramentas, por isso achei legal criar um passo a passo de como publicar seus projetos do Google Colab no GitHub.
Vamos lá?
O Google Colaboratory é uma plataforma na nuvem onde você consegue escrever e executar códigos Python em Jupyter Notebooks sem precisar instalar nenhum ambiente em sua máquina. Basta você possuir uma conta do Google (GMail) que poderá utilizar o sistema. Ele vai salvando os seus notebooks no Google Drive.
Criando um notebook no Google Colaboratory
Vamos começar acessando o Google Colaboratory pelo link https://colab.research.google.com/
Ao conectar, ele vai carregar um notebook inicial. Ele possui uma descrição do que é o Colab e as suas funcionalidades.
Para criar um novo Notebook, precisamos conectar nossa conta do GMail (caso ainda não esteja). Basta clicar no botão azul “Sign In” localizado no topo a direita.
Ao conectar nossa conta e voltarmos ao link inicial, vamos encontrar a tela acima. Nesta tela podemos abrir projetos já criados ou então criar um novo notebook. Vamos criar um novo notebook clicando em “New Notebook”.
Quando criamos um novo notebook, recebemos a seguinte tela:
Acima, em Untitled1.ipnyb, este é o nome do nosso Notebook. Vamos alterá-lo para HelloWorld.ipnyb
Abaixo, temos uma caixa cinza, juntamente com o símbolo de play (para executar as tarefas).
Nesta caixa, podemos digitar códigos Python. O objetivo deste artigo não será de ensinar Python, somente de criar os notebooks e publicar no GitHub. Então, vamos somente inserir um print(‘Olá Mundo!’). Apertamos Shift + Enter e ele irá executar o código.
Veja que o código foi executado e obtemos o resultado logo abaixo.
Vamos agora criar o repositório no GitHub.
Criando um Repositório no GitHub
Acesse https://github.com e crie uma conta, caso ainda não possua, clicando em Sign up no botão superior direito ou então entre na sua conta clicando em Sign In.
Com sua conta conectada, vamos criar um novo repositório com o nome de exemplo-colaboratory.
Para isto, clique no sinal de + localizado ao lado da sua foto de perfil no menu superior direito, e em seguida clique em “New Repository”
Nesta nova tela, vamos adicionar o nome do nosso repositório, marcar como publico e selecionar a caixa “Initialize this repository with a README”
O arquivo Readme seria a capa do seu projeto. Nele você pode adicionar as informações do seu projeto, como executá-lo, entre outras.
Clique agora em Create Repository
Está será a tela inicial do seu projeto no GitHub
Veja que ele leu o nosso arquivo readme.md e exibiu na tela inicial do nosso projeto.
Agora vamos agora fazer a conexão e o Link com o Github.
Conectando ao GitHub
Para conectar o seu Colab ao GitHub, clique em File no menu superior esquerdo e selecionar a opção “Save a copy in GitHub”.
Ao clicar nesta opção, uma tela vai abrir com a solicitação para conectar ao seu GitHub. Vamos clicar em Authorize googlecolab.
Autorizando, a página será fechada e você poderá ver os repositórios criados.
Vamos procurar nosso repositório criado na etapa anterior. Clique em Repository para abrir a lista e vamos procurar o repositório exemplo-colaboratory. No meu caso estará luizhfraraujo/exemplo-colaboratory.
ps: Caso o seu projeto não tenha aparecido, feche esta tela, verifique se o projeto foi criado corretamente e repita o processo de salvar no github.
Com o projeto selecionado, ele irá publicar nosso arquivo na branch Master, a principal do nosso projeto.
Em file path encontramos o nome do nosso arquivo, e como ele será chamado no GitHub;
Em commit message, temos a mensagem que será exibida ao publicar nosso notebook no github.
Include a link to Colaboratory irá adicionar um link em nosso arquivo para direcionar o usuário para o Notebook no Colab.
Vamos deixar nossa publicação como a imagem abaixo
Com as informações preenchidas, clique em OK e aguarde. Se tudo correr certo, ele irá publicar seu notebook no GitHub e irá redirecioná-lo para a página:
Veja que ele adicionou uma Badge com o nome Open in Colab, que é aquela opção que deixamos marcada.
Vamos voltar para a raiz do nosso projeto no github e adicionar no Readme.MD um link para nosso arquivo no Colab. Para isto, clique em exemplo-colaboratory, ao lado de “Branch: master”.
Agora, clique no símbolo de Lápis para editar nosso ReadMe.MD
Vai abrir uma tela semelhante a da imagembaixo
Para editar este arquivo, vou recomendar a vocês um editor online que eu uso que é o https://stackedit.io/app
Ao conectar ele carrega um arquivo Welcome File, mostrando dicas de como utilizar o Markdown.
Vamos apagar tudo que está do lado branco e criar nosso texto. em cima você encontra uma barra de edição onde você pode colocar palavras como texto, negrito, itálico, entre outras opções.
Digite o seguinte texto
# Exemplo Colaboratory
Este é um repositório com o exemplo criado pelo Google Colaboratory.
[HelloWorld.ipnyb](/HelloWorld.ipynb)
Você verá que na parte cinza no texto será exibido no formato que o texto ficará em nosso readme.md.
Vamos copiar o texto e colar no nosso arquivo readme.md
Agora vá no final da página e clique em Commit Changes para subir nossa alteração
Veja que agora nosso arquivo readme.md foi atualizado e a raiz do nosso projeto agora está assim:
Se clicarmos no link HelloWorld.ipnyb ele vai abrir nosso Notebook que está em nosso GitHub.
Espero ter ajudado a todos!
Qualquer dúvida, deixe ai nos comentários!
Grande abraço!
