📖 Introdução ao KAIRUS

KAIRUS é um aplicativo desktop para anotações seguras com criptografia AES-256, desenvolvido em Python com PySide6.

Sobre o KAIRUS

O KAIRUS foi desenvolvido com foco em privacidade e segurança. Todas as notas são criptografadas localmente antes de serem salvas, garantindo que apenas você tenha acesso ao seu conteúdo.

⚙️ Instalação

Windows (Instalador)

1. Baixe o instalador kairus.exe da página de releases
2. Execute o arquivo baixado
3. Siga as instruções do assistente de instalação
4. Após a instalação, inicie o KAIRUS pelo atalho na área de trabalho

Windows (Portátil)

1. Baixe a versão portátil (caso disponível)
2. Extraia o arquivo ZIP em uma pasta de sua escolha
3. Execute kairus.exe diretamente

A partir do código fonte

# Clone o repositório
git clone https://github.com/EduardoDosSantosFerreira/kairus.git
cd kairus

# Crie um ambiente virtual (recomendado)
python -m venv venv
venv\Scripts\activate  # No Windows

# Instale as dependências
pip install -r requirements.txt

# Execute o aplicativo
python main.py

📋 Requisitos do Sistema

🚀 Primeiros Passos

1. Primeira execução

Ao iniciar o KAIRUS pela primeira vez, você precisará definir uma senha mestra que protegerá todas as suas notas.

2. Criando sua primeira nota

1. Clique em Nova Nota ou pressione Ctrl+N
2. Digite um título e o conteúdo da nota
3. A nota é salva automaticamente

3. Criando uma pasta segura

1. Clique em Nova Pasta ou pressione Ctrl+Shift+N
2. Digite o nome da pasta
3. Defina uma senha para a pasta (opcional)
4. Clique em Criar

🖥️ Interface do Usuário

Interface principal do KAIRUS

📝 Gerenciamento de Notas

Criar Nota

# Exemplo via API interna
note_manager.create_note(
    title="Minha Nota",
    content="Conteúdo da nota...",
    folder_id="id_da_pasta"
)

Editar Nota

Clique em qualquer nota na árvore de pastas para abri-la no editor. As alterações são salvas automaticamente.

Excluir Nota

Selecione a nota e pressione Delete ou clique com botão direito → Excluir.

🔒 Pastas Protegidas

Pastas com senha oferecem uma camada extra de segurança para grupos específicos de notas.

Como funciona

• Cada pasta pode ter sua própria senha independente
• O conteúdo da pasta é criptografado com a senha definida
• Ao acessar uma pasta protegida, a senha é solicitada
• A pasta permanece acessível durante a sessão atual

⌨️ Atalhos de Teclado

📤 Exportação

O KAIRUS permite exportar notas nos seguintes formatos:

• PDF - Preserva formatação e é ideal para compartilhamento
• TXT - Texto puro, compatível com qualquer editor

Como exportar

1. Abra a nota que deseja exportar
2. Clique no botão Exportar na barra de ferramentas
3. Escolha o formato desejado
4. Selecione o local para salvar
5. Clique em Salvar

🔐 Criptografia

O KAIRUS implementa padrões de segurança robustos para proteger seus dados.

Algoritmos utilizados

💾 Armazenamento de Dados

Todos os dados são armazenados localmente no diretório do usuário.

# Localização dos dados do KAIRUS
C:\Users\[Usuario]\AppData\Local\kairus\
├── config/
│   └── settings.json
├── data/
│   ├── notes/
│   └── vault/
└── logs/

📁 Estrutura do Projeto

kairus/
├── build/              # Arquivos de build
├── core/               # Lógica central do aplicativo
├── dist/               # Executáveis gerados
├── security/           # Módulo de criptografia e segurança
├── storage/            # Gerenciamento de armazenamento
├── ui/                 # Interface do usuário (PySide6)
├── utils/              # Utilitários diversos
├── web/                # Site/documentação web
│   ├── css/
│   ├── img/
│   └── index.html
├── main.py             # Ponto de entrada principal
├── requirements.txt    # Dependências Python
└── README.md           # Documentação principal

📚 API Reference

SecurityManager

NoteManager

🤝 Contribuição

KAIRUS é open source e aceita contribuições!

Como contribuir

1. Faça um fork do repositório
2. Crie uma branch para sua feature: git checkout -b minha-feature
3. Commit suas alterações: git commit -m 'Adiciona nova feature'
4. Push para a branch: git push origin minha-feature
5. Abra um Pull Request

Testes

Execute os testes antes de enviar seu PR:

python -m pytest tests/

❓ Perguntas Frequentes

🔧 Solução de Problemas