Skip to content

Latest commit

 

History

History
73 lines (51 loc) · 2.21 KB

README.rst

File metadata and controls

73 lines (51 loc) · 2.21 KB

wire-protocol

Build Status codecov Code Climate Issue Count

Documentation Status

Android Debug Bridge (ADB) Wire Protocol

Status

This project is actively maintained and under development.

Installation

To install wire-protocol from pip:

$ pip install adbwp

To install wire-protocol from source:

$ git clone [email protected]:adbpy/wire-protocol.git
$ cd wire-protocol && python setup.py install

Goals/Scope

A standalone library that can be used for building protocol objects while remaining transport/application protocol agnostic. The wire protocol should care about:

  • Byte layout on the wire
  • Model representation of Messages (header + payload)
  • Provide simple API that convert bytes to/from models

The wire protocol should not care, nor have concept of:

  • Synchronous vs. Asynchronous
  • TCP, UDP, USB
  • Sequence of messages required to complete a connection “handshake”
  • Cryptography required to verify endpoints
  • Anything else not explicitly mentioned above…

Contributing

If you would like to contribute, simply fork the repository, push your changes and send a pull request. Pull requests will be brought into the master branch via a rebase and fast-forward merge with the goal of having a linear branch history with no merge commits.

License

Apache 2.0