https://github.com/sthagen/python-nocat

Python No Cat is a client communicating via text protocol to endpoints of certain kinds.
https://github.com/sthagen/python-nocat

client netcat python text-protocol

Last synced: 4 days ago
JSON representation

Python No Cat is a client communicating via text protocol to endpoints of certain kinds.

• Host: GitHub
• URL: https://github.com/sthagen/python-nocat
• Owner: sthagen
• License: mit
• Created: 2017-06-30T17:54:29.000Z (over 7 years ago)
• Default Branch: default
• Last Pushed: 2022-06-19T09:47:15.000Z (over 2 years ago)
• Last Synced: 2024-12-16T13:46:08.585Z (6 days ago)
• Topics: client, netcat, python, text-protocol
• Language: Python
• Size: 32.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# python-nocat

Python No Cat is a client communicating via text protocol to endpoints of certain kinds.

## Synopsis

Simple module that offers client functionality adding a few ease of use aspects when compared to plain `netcat` usage. 

You can configure facts about the protocol used like e.g. the special commands inside `JSON` configuration files that are read upon start.

A sample configuration is provided that should get you started easily.

In case a working `readline` module is detected upon start, the usual UNIX command line comfort like navigation, incremental search and history are not blocked ;-).

If such an install is not present, a minimal history functionality is offered but otherwise no interactive fun aspect ...

## Status

Experimental

## Install

Not yet on the cheese shop, but when this is done, a simple `pipx install nocat` or `python -m pip install nocat` should be sufficient.

## Development

A simple example (including a specific text protocol definition and macros) will be provided.

	```

	Todo

	```

### Test

Tests will be provided based on the usual `unittest`, `doctest`, and `pytest`. 

Presumably `tox` will be used to ensure regression tests on all relevant platforms are being run easily.

	```

	Todo

	```

Enjoy!

**Note**: The default branch is `default`.