Skip to main content

CLI to list serial (COM/USB) ports on Windows, Linux & macOS

Project description

🔌 Dircom

CI

Dircom é um utilitário de linha de comando leve, multiplataforma e escrito em Python, para listar portas seriais disponíveis no sistema — com destaque para portas USB. Ideal para desenvolvedores que trabalham com ESP32, Arduino, Raspberry Pi, sensores e outros dispositivos seriais.


🚀 Funcionalidades

  • Lista todas as portas COM/seriais disponíveis
  • Filtra somente portas conectadas via USB (--usb-only)
  • Marcação clara de portas USB com tag [USB]
  • Compatível com Windows, Linux e macOS
  • Interface por linha de comando, fácil de usar
  • Compilável em .exe para uso offline em Windows

💻 Uso

python dircom.py

Opções:

Parâmetro Descrição
-u, --usb-only Mostra apenas portas USB
-v, --version Mostra a versão atual do utilitário
-h, --help Exibe ajuda e instruções de uso

Exemplos:

python dircom.py --usb-only
python dircom.py -v

🔧 Instalação

Requisitos:

  • Python 3.6 ou superior
  • Biblioteca pyserial

Instale com pip:

pip install pyserial

🛠️ Compilando para .exe no Windows

Para distribuir como um executável standalone (sem Python instalado):

1. Instale o PyInstaller

pip install pyinstaller

2. Compile o script

pyinstaller --onefile --name dircom dircom.py

O executável será gerado em:

dist/dircom.exe

🐧 Linux/macOS

Você pode rodar com:

python3 dircom.py

Ou compilar com PyInstaller no próprio sistema operacional.


📂 Estrutura recomendada

dircom/
├── dircom.py
├── README.md
├── .gitignore
├── requirements.txt
└── LICENSE

📦 Requisitos

Conteúdo de requirements.txt:

pyserial>=3.5

📜 Licença

Distribuído sob a licença MIT.


🤝 Contribuições

Contribuições são bem-vindas! Sinta-se livre para abrir issues ou pull requests com melhorias, sugestões ou correções.


📝 TODO

  • Testar funcionalidade completa no Windows
  • Testar no Linux com diversas distribuições
  • Testar no macOS (ainda não verificado)
  • Adicionar testes automatizados (opcional)
  • Criar executável para Linux e macOS com PyInstaller
  • Publicar no PyPI (como pacote Python)

Sinta-se à vontade para contribuir com testes ou melhorias!

🔗 Autor

Nelson Almeida
github.com/ncamilo

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dircom-1.0.1.tar.gz (15.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dircom-1.0.1-py3-none-any.whl (15.9 kB view details)

Uploaded Python 3

File details

Details for the file dircom-1.0.1.tar.gz.

File metadata

  • Download URL: dircom-1.0.1.tar.gz
  • Upload date:
  • Size: 15.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.11

File hashes

Hashes for dircom-1.0.1.tar.gz
Algorithm Hash digest
SHA256 1530ac7f7e32b6444136d12db4b25b6870584a7ff1571515aca2ecf42bb510ce
MD5 42280fe7aa47b9b58392747d8a5401a3
BLAKE2b-256 bbeb8b3bf48f7e7ecb67a691a609654906aea512f3a89ea41b1522747ab6bc11

See more details on using hashes here.

File details

Details for the file dircom-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: dircom-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 15.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.11

File hashes

Hashes for dircom-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 65f71acc31a4f604bd0c14fe2a7d34d710b781562c498207f706a39795ad1bd5
MD5 94447cb7f86fc4b47da7822ec10ce2a1
BLAKE2b-256 1a464a02579889dfd6099d022fff97ccb8748b50b4a7d809994a70d3ca07a8d2

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page