Metadata-Version: 2.1
Name: pybots
Version: 2.0.6
Summary: Devkit for quickly creating client bots for remote communications
Home-page: https://github.com/dhondta/python-pybots
Author: Alexandre D'Hondt
Author-email: alexandre.dhondt@gmail.com
License: AGPLv3
Description: [![PyPi](https://img.shields.io/pypi/v/pybots.svg)](https://pypi.python.org/pypi/pybots/)
        [![Read The Docs](https://readthedocs.org/projects/python-pybots/badge/?version=latest)](http://python-pybots.readthedocs.io/en/latest/?badge=latest)
        [![Build Status](https://travis-ci.org/dhondta/python-pybots.svg?branch=master)](https://travis-ci.org/dhondta/python-pybots)
        [![Requirements Status](https://requires.io/github/dhondta/python-pybots/requirements.svg?branch=master)](https://requires.io/github/dhondta/python-pybots/requirements/?branch=master)
        [![Known Vulnerabilities](https://snyk.io/test/github/dhondta/python-pybots/badge.svg?targetFile=requirements.txt)](https://snyk.io/test/github/dhondta/python-pybots?targetFile=requirements.txt)
        [![Python Versions](https://img.shields.io/pypi/pyversions/pybots.svg)](https://pypi.python.org/pypi/pybots/)
        [![License](https://img.shields.io/pypi/l/pybots.svg)](https://pypi.python.org/pypi/pybots/)
        
        # PyBots
        
        This library aims to quickly write client bots for communicating with remote hosts in various ways.
        
        It currently features the following bots:
        - Protocol-bound: TCPBot, HTTPBot, JSONBot, IRCBot, EPassport
        - Application-specific:
          - CTF: RingZer0Bot, RootMeIRCBot, ZSISBot
          - Security: ShodanBot, VirusTotalBot
          - Miscellaneous: GitRecoveryBot
          
        
        ## Installation
        
        ```
        sudo pip install pybots
        ```
        
        
        ## Usage
        
        Each bot class is implemented as a context manager and has a logger attached. It can thus be instantiated in a clear and straightforward way. Here is an example:
        
        ```py
        from pybots import TCPBot
        
        with TCPBot("remote_host", 1234) as bot:
            data = bot.send_receive("Hello!")
            # do something with data
        ```
        
        Note that, if a bot is used behind a proxy, it will use system's proxy settings. This can be bypassed by using `no_proxy=True` while instantiating the bot.
        
        ```py
        with TCPBot("LAN_host", 1234, no_proxy=True) as bot:
            # ...
        ```
        
        
        ## CTF Examples
        
        * [Hacky Easter 2017 (22 & 24)](doc/examples/hacky-easter-2017.md)
        * [Hackvent 2017 (Day 06 & 10)](doc/examples/hackvent-2017.md)
        * [RingZer0 / Coding (13 & 17)](doc/examples/ringzer0.md)
        * [Root-Me / Programming](doc/examples/rootme.md)
        
        
        ## Contribution
        
        For contributions or suggestions, please [open an Issue](https://github.com/dhondta/python-pybots/issues/new) and clearly explain, using an example or a use case if appropriate. 
        
        If you want to get new bots added, please submit a Pull Request.
        
Keywords: python,development,programming,framework,cli,devkit
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: !=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*!=3.4.*,<4,>=2.7
Description-Content-Type: text/markdown
