Metadata-Version: 2.1
Name: Signalum
Version: 0.0.6
Summary: Package to analyze existing connections from wifi and bluetooth
Home-page: https://github.com/bisoncorps/signalum
Author: Domnan Diretnan, Mmadu Manasseh
Author-email: diretnandomnan@gmail.com
License: MIT
Description: # Signalum
        
        A Linux Package to detect and analyze existing connections from wifi and bluetooth
        
        [![Build Status](https://travis-ci.com/bisoncorps/signalum.svg?branch=master)](https://travis-ci.com/bisoncorps/signalum)
        [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
        [![PyPI version](https://badge.fury.io/py/Signalum.svg)](https://badge.fury.io/py/Signalum)
        
        - [Signalum](#signalum)
          - [Installation](#installation)
          - [Development](#development)
          - [Usage](#usage)
          - [Contribution](#contribution)
          - [License (MIT)](#license-mit)
        
        ## Installation
        
        ```bash
            pip install signalum
        ```
        
        ## Development
        
        ```bash
            git clone git@github.com:bisoncorps/signalum.git
        
            sudo apt-get install bluetooth libbluetooth-dev
        
            pip install -r requirements.txt
        
        ```
        
        
        
        ## Usage
        
        Signalum comes with a cli tool called `signalyze`
        ![Demo](output.gif)
        
        ```bash
          ▄▄▄▄    ▄                         ▀▀█           ▄▄▄▄▄▄
         █▀   ▀   █     ▄▄▄▄  ▄ ▄▄    ▄▄▄     █    ▄   ▄      █▀  ▄▄▄
         ▀█▄▄▄    █    █▀ ▀█  █▀  █  ▀   █    █    ▀▄ ▄▀    ▄█   █▀  █
             ▀█   ▀    █   █  █   █  ▄▀▀▀█    █     █▄█    ▄▀    █▀▀▀▀
         ▀▄▄▄█▀   █    ▀█▄▀█  █   █  ▀▄▄▀█    ▀▄▄   ▀█    ██▄▄▄▄ ▀█▄▄▀
                        ▄  █                        ▄▀
                         ▀▀                        ▀▀
                         ▀▀                        ▀▀
        usage: signalyze [-h] [-o OUTPUT] [--show-name] [-b | -w | -all] [--show-graph | --show-extra-info]
        optional arguments:
            -h, --help            show this help message and exit                  
            -o OUTPUT, --output OUTPUT  save to an output csv file                       
            --show-name           Show Device name and mac address                 
            -b, --bluetooth       Analyze only bluetooth                           
            -w, --wifi            Analyze only wifi                                
            -all, --analyze-all   Analyze both wifi and bluetooth  
            --show-graph          Show Realtime graph of nearby devices
            --show-extra-info     Show extra information like services and device  classification   
        ```
        
        
        ## Contribution
        
        You are very welcome to modify and use them in your own projects.
        
        ## License (MIT)
        
        This project is opened under the [MIT 2.0 License](https://github.com/bisoncorps/signalum/blob/master/LICENSE) which allows very broad use for both academic and commercial purposes.
        
Keywords: bluetooth detect wifi multiprotocol
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX
Description-Content-Type: text/markdown
