Extrator de SPED Fiscal é uma iniciativa de código aberto que nasceu perante a necessidade de quebra desta modalidade de arquivo e a dificuldade vivenciada pelas mais diversas áreas de negócios. O objetivo principal da ferramenta é trazer liberdade tecnológica e acessibilidade aos mais diversos públicos, focado nos não especializados em tecnologia, de forma simples e descomplicada. Assim, permitindo às áreas de tecnologia, focarem seus recursos para trabalhos de maior complexidade.
Esse projeto conta com uma licença para código aberto do MIT. Para maiores informações, ler o arquivo LICENSE.md ou acessar o link.
Desenvolvedores, ir para a secção dedicada.
Para baixar o aplicativo, basta ir para a parte dos releases ou clicar no link. Uma vez na área mencionada, localizar a última versão e finalmente, abrir as opções para baixar o arquivo ESF.exe.
No momento de instalar o aplicativo, o instalador pedirá para inserir o diretório onde será salva a ferramenta. Importante: Lembrar do caminho onde foi salva, será usado depois.
Quando a ferramenta estiver instalada, acessar a pasta da instalação, e opcionalmente, criar um atalho do arquivo main.exe clicando com botão direito no arquivo e selecionando a opção de criar atalho. Um atalho será criado na pasta, o mesmo poderá ser movido para outra localização como a Área de Trabalho e o nome poderá ser trocado também.
OBS: Talvez, no momento da instalação, o Windows Defender levante uma alerta. Para continuar, clicar em "Mais informações > Executar".
A ferramenta ainda não conta com uma interface gráfica (GUI), motivo pelo qual devemos rodar ela por linha de comando. Para realizar isso, devemos seguir as seguintes instruções:
- Abrir o File Explorer e ir na pasta do executável (main.exe) ou do atalho criado.
- Na barra superior de busca, digitar "cmd" e clicar Enter.
- Uma janela de linha de comando vai abrir no diretório, alí deve digitar:
start main.exe <opções>se for executar diretamente na pasta do projeto. Caso seja na localizaçao do atalho o comando será:start <nome_do_atalho>.lnk <opções> - Esperar o programa terminar de rodar.
| Flag | Extended Flag | Description |
|---|---|---|
| -h | --help | show this help message and exit |
| -i | --input_dir | Specify the directory where SPEDs are located between quotation marks (""). Default value is in "Extrator SPED Fiscal/data". |
| -o | --output_dir | Specify the directory where the excel files will be saved between quotation marks (""). Default value is in "Extrator SPED Fiscal/data". |
| -v | --verbose | Specify verbosity of the process. Default value is False. |
| -r | --regs | Specify the Regs to be exported separated by spaces, as in the following example: 0001 0150 0200 C100 C190. Default value will consider all regs identified per file. |
Varias combinações de opções são possíveis.
Para mostrar informações do processamento:
start main.exe -v
Para processar registros específicos:
start main.exe -r 0000 0150 0200 C100 C170 C190
Para especificar o diretorio de leitura dos arquivos:
start main.exe -i "diretorio/dos/arquivos"
Para especificar o diretorio de escritura dos arquivos:
start main.exe -o "diretorio/dos/arquivos"
Para especificar o diretorio de leitura e escritura dos arquivos:
start main.exe -i "diretorio/de/leitura" -o "diretorio/de/escritura"
Depois de rodar a ferramenta, o procesamento dos arquivos estará na pasta indicada pelo usuario (Obs: Caso não seja especificado, o resultado do processamento será encontrado na pasta diretorio/de/preferência/Extrator_SPEDFiscal/data). Um arquivo de log sera criado como parte do output, indicando a existencia de algum erro ou aviso.
- Analisar diretamente no Excel com Pivot Tables e VLOOKUP.
- Importar arquivos para um Banco de Dados e realizar análises.
- Ler os arquivos em Alteryx para realizar Análises Exploratoria de Dados(EDA).
- Importar arquivos em ferramenta de visualização de dados como: Power BI, Tableu, Qlik.
- Desenvolver lógica de atrelhar os REGs.
- Desenvolvimento de Interface Gráfica (GUI).
Para reportar os erros a serem corrigidos em proximos releases, é necessario seguir os seguintes passos:
- Conferir os problemas reportados anteriormente, para evitar duplicação.
- Usar o log ou o erro para descrever detalhadamente.
- Se necesario, tirar print e anexar.
- Enviar o report.
Para realizar colaborações, por favor, seguir a seguinte convenção:
- Clonar a branch stable.
- Instalar as dependencias do arquivo **requirements.txt.
- Escolher um único item para trabalhar por vez.
- Realizar o Pull Request para a branch stable
- Para correções de bugs existentes, nomear "Issue - <Nome do PR>" e referenciar o id do issue.
- Para melhorias no codigo, nomear "Feature - <Nome do PR>".
- Mandar o PR para revisão.
Para instalação via git, digitar o seguinte comando: git clone https://github.com/BernardoB95/Extrator_SPEDFiscal
Esse segmento da documentação é específico para os desenvolvedores que colaborarão com o projeto ou simplesmente clonarão e melhorarão para o uso interno nas empresas. O projeto conta com um arquivo de requerimentos para o correto funcionamento da ferramenta. Para instalar, na consola inserir:
pip install -r requirements.txt
Contém o arquivo IFactory.py, que herda do modulo ABC e funciona igual uma interface. Todas as classes definidas nas pastas, são factories que implementam a classe IFactory e nos permitirão instanciar objetos dinamicamente.
É um diretorio auxiliar onde consta o manual de SPED Fiscal usado para desenvolver a ferramenta. Adicionalmente, será utilizado como diretório padrão de leitura e escritura.
Contém o arquivo IReg.py, que herda do modulo ABC e funciona igual uma interface. Todas as classes definidas nas pastas, são factories que implementam a classe IReg e nos permitirão instanciar objetos dinamicamente.
Contém todos os arquivos auxiliares para o desenvolvimento da ferramenta.
Para a geração do executável, o módulo pyinstaller é utilizado. Uma vez realizada as correções, na consola, é necessario executar o seguinte comando:
pyinstaller --onefile main.spec
Duas pastas serão criadas, dist a qual contem o executável e precisará ser colocado na pasta principal para ele encontrar todas as dependências do programa, e build, que contem todos os arquivos referentes à geração do executável. As duas pastas podem ser eliminadas depois.