Instalacao via pip

A forma mais simples de instalar o pyqog e via pip, o gerenciador de pacotes do Python:

pip install pyqog

Isso instalara o pyqog e todas as suas dependencias automaticamente.

Dica: Recomendamos usar um ambiente virtual (venv ou conda) para isolar as dependencias do projeto.

Usando ambiente virtual (recomendado)
# Criar ambiente virtual
python -m venv .venv

# Ativar (Linux/Mac)
source .venv/bin/activate

# Ativar (Windows)
.venv\Scripts\activate

# Instalar pyqog
pip install pyqog
Usando conda
# Criar ambiente conda
conda create -n qog python=3.11
conda activate qog

# Instalar pyqog
pip install pyqog

Requisitos

Requisito Versao Minima Descricao
Python 3.9+ Linguagem de programacao
pandas 1.5.0+ Manipulacao e analise de dados tabulares
requests 2.28.0+ Requisicoes HTTP para download dos dados

O pyqog foi projetado para ser minimalista, com apenas duas dependencias externas. Ambas sao bibliotecas amplamente utilizadas e estaveis.

Instalacao de Desenvolvimento

Para contribuir com o projeto ou modificar o codigo fonte, instale em modo de desenvolvimento:

# Clonar o repositorio
git clone https://github.com/prof-danny-idp/pyqog.git
cd pyqog

# Criar ambiente virtual
python -m venv .venv
source .venv/bin/activate  # ou .venv\Scripts\activate no Windows

# Instalar em modo editavel
pip install -e .

# Instalar dependencias de teste
pip install pytest
Executar testes
# Rodar todos os testes
pytest

# Rodar com output detalhado
pytest -v

# Rodar um teste especifico
pytest tests/test_urls.py

Verificacao da Instalacao

Apos instalar, verifique que tudo esta funcionando:

import pyqog

# Verificar versao
print(pyqog.__version__)

# Listar datasets disponiveis
print(pyqog.list_datasets())

# Testar download (requer internet na primeira vez)
df = pyqog.read_qog()
print(f"Dataset carregado: {df.shape[0]} linhas, {df.shape[1]} colunas")

Nota: O primeiro download requer conexao com a internet. Apos o download, os dados sao armazenados em cache em ~/.pyqog/cache/ e podem ser acessados offline.

Desinstalacao

Para remover o pyqog:

pip uninstall pyqog

Para remover tambem o cache local de dados:

# Linux/Mac
rm -rf ~/.pyqog/

# Windows (PowerShell)
Remove-Item -Recurse -Force ~\.pyqog\