Renamed Rozzy to ROSWire (#127)

* renamed Rozzy to ROSWire

* updated .rozzy refs

* updated test refs

* updated exceptions

* woops

* updated docs

* renamed package to roswire

* updated README

* updated docs

Author: ChrisTimperley

README.md renamed to README.rst

@@ -1,8 +1,13 @@
-# rozzy
+.. -*-restructuredtext-*-
 
-[![Build Status](https://travis-ci.com/ChrisTimperley/rozzy.svg?token=NEepgzkwf1KGUTphtdZ4&branch=master)](https://travis-ci.com/ChrisTimperley/rozzy)
+roswire
+=======
 
-## Features
+.. image:: https://travis-ci.org/ChrisTimperley/roswire.svg?branch=master
+    :target: https://travis-ci.org/ChrisTimperley/roswire
+
+Feature Roadmap
+----------------
 
 * Supports ROS 1 and 2.
 * Differential coverage collection for C, C++ and Java.
@@ -14,7 +19,8 @@
 * Trace collection and streaming.
 
 
-## Applications
+Applications
+------------
 
 * Property-based testing
 * Blackbox fuzzing

docs/conf.py

@@ -14,19 +14,19 @@
 
 import os
 import sys
-import rozzy
+import roswire
 
 
 # -- Project information -----------------------------------------------------
 
-project = 'Rozzy'
+project = 'roswire'
 copyright = '2019, Christopher Steven Timperley'
 author = 'Christopher Steven Timperley'
 
 # The short X.Y version
-version = rozzy.__version__
+version = roswire.__version__
 # The full version, including alpha/beta/rc tags
-release = rozzy.__version__
+release = roswire.__version__
 
 
 # -- General configuration ---------------------------------------------------
@@ -110,7 +110,7 @@
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'Rozzydoc'
+htmlhelp_basename = 'roswiredoc'
 
 
 # -- Options for LaTeX output ------------------------------------------------
@@ -137,7 +137,7 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'Rozzy.tex', 'Rozzy Documentation',
+    (master_doc, 'roswire.tex', 'ROSWire Documentation',
      'Christopher Steven Timperley', 'manual'),
 ]
 
@@ -147,7 +147,7 @@
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    (master_doc, 'rozzy', 'Rozzy Documentation',
+    (master_doc, 'roswire', 'ROSWire Documentation',
      [author], 1)
 ]
 
@@ -158,8 +158,8 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'Rozzy', 'Rozzy Documentation',
-     author, 'Rozzy', 'One line description of project.',
+    (master_doc, 'ROSWire', 'ROSWire Documentation',
+     author, 'ROSWire', 'One line description of project.',
      'Miscellaneous'),
 ]
 

docs/index.rst

@@ -1,12 +1,14 @@
-Rozzy
-=====
+.. -*-restructuredtext-*-
 
+roswire
+=======
 
-Rozzy is a Python library for performing static and dynamic analysis of
+
+ROSWire is a Python library for performing static and dynamic analysis of
 containerised `Robot Operating System (ROS) <https://ros.org>`_
 applications.
 Given a ROS application in the form of a `Docker <https://docker.org>`_
-image, Rozzy provides an interface for statically querying the application
+image, ROSWire provides an interface for statically querying the application
 (e.g., by automatically discovering its types, packages, messages, service,
 actions, etc.), as well as an interface for dynamically generating and
 interacting with instances of that application in the form of Docker
@@ -19,26 +21,26 @@ Installation
 
 To avoid interfering with the rest of your system (i.e., to avoid Python's
 equivalent of DLL hell), we strongly recommend that
-Rozzy is installed within a
+ROSWire is installed within a
 `virtualenv <https://virtualenv.pypa.io/en/latest/>`_ or
 `pipenv <https://pipenv.readthedocs.io/en/latest/>`_ (pipenv is preferred).
 
 From within the virtual environment (i.e., the `virtualenv` or `pipenv`),
-the latest stable release of Rozzy on `PyPI <https://pypi.org>`_
+the latest stable release of ROSWire on `PyPI <https://pypi.org>`_
 can be installed via:
 
 .. code:: shell
 
-   (rozzy) $ pip install rozzy
+   (roswire) $ pip install roswire
 
-Rozzy can also be installed from source:
+ROSWire can also be installed from source:
 
 .. code:: shell
 
-   $ git clone [email protected]:ChrisTimperley/rozzy rozzy
-   $ cd rozzy
+   $ git clone [email protected]:ChrisTimperley/roswire roswire
+   $ cd roswire
    $ pipenv shell
-   (rozzy) $ pip install .
+   (roswire) $ pip install .
 
 
 Getting Started
@@ -54,8 +56,8 @@ service and action types:
 
    image = 'myrosapp'  # name of the Docker image for the ROS app
 
-   # create a new Rozzy session
-   rozzy = Rozzy()
+   # create a new roswire session
+   roswire = ROSWire()
 
    # we can obtain a static description of the application
    #
@@ -65,21 +67,21 @@ service and action types:
    #   description to disk (unless told not).
    # * descriptions in the cache are indexed by the SHA256 ID of the Docker
    #   image. If the image changes or a different tag is used for the same
-   #   image, Rozzy is smart enough to load an existing description or build
+   #   image, ROSWire is smart enough to load an existing description or build
    #   a new one accordingly.
    #
-   description = rozzy.descriptions.load_or_build(image)
+   description = roswire.descriptions.load_or_build(image)
 
 
 API Reference
 -------------
 
 
-.. py:module:: rozzy
-.. autoclass:: Rozzy
+.. py:module:: roswire
+.. autoclass:: ROSWire
   :members:
 
-.. py:module:: rozzy.description
+.. py:module:: roswire.description
 .. autoclass:: SystemDescriptionManager()
   :members:
 

setup.py

@@ -3,19 +3,19 @@
 from setuptools import setup, find_packages
 
 
-path = os.path.join(os.path.dirname(__file__), 'src/rozzy/version.py')
+path = os.path.join(os.path.dirname(__file__), 'src/roswire/version.py')
 with open(path, 'r') as f:
     exec(f.read())
 
 
 setup(
-    name='rozzy',
+    name='roswire',
     version=__version__,
     python_requires='>=3.5',
     description='An API for testing and mutating ROS systems.',
     author='Chris Timperley',
-    author_email='[email protected]',
-    url='https://github.com/squaresLab/rozzy',
+    author_email='[email protected]',
+    url='https://github.com/ChrisTimperley/roswire',
     license='mit',
     install_requires=[
         'attrs>=17.2.0',

src/rozzy/__init__.py renamed to src/roswire/__init__.py

@@ -1,4 +1,4 @@
 from .version import __version__
 from .proxy import ShellProxy, ROSProxy
 from .system import System, SystemDescription
-from .rozzy import Rozzy
+from .roswire import ROSWire