MANIFEST.in

+include LICENSE
+include README.md
+include VERSION
+include burpui.cfg
+include burp-ui.py
+recursive-include burpui *

README.md

@@ -81,14 +81,14 @@ Burp-UI is released under the BSD 3-clause [License](LICENSE).
 
 But this project is built on top of other tools listed here:
 
-- [d3.js](http://d3js.org/) ([BSD](static/d3/LICENSE))
-- [nvd3.js](http://nvd3.org/) ([Apache](static/nvd3/LICENSE.md))
-- [jQuery](http://jquery.com/) ([MIT](static/jquery/MIT-LICENSE.txt))
-- [jQuery-UI](http://jqueryui.com/) ([MIT](static/jquery-ui/MIT-LICENSE.txt))
-- [fancytree](https://github.com/mar10/fancytree) ([MIT](static/fancytree/MIT-LICENSE.txt))
-- [bootstrap](http://getbootstrap.com/) ([MIT](static/bootstrap/LICENSE))
-- [typeahead](http://twitter.github.io/typeahead.js/) ([MIT](static/typeahead/LICENSE))
-- [bootswatch](http://bootswatch.com/) ([MIT](static/bootstrap/bootswatch.LICENSE))
+- [d3.js](http://d3js.org/) ([BSD](burpui/static/d3/LICENSE))
+- [nvd3.js](http://nvd3.org/) ([Apache](burpui/static/nvd3/LICENSE.md))
+- [jQuery](http://jquery.com/) ([MIT](burpui/static/jquery/MIT-LICENSE.txt))
+- [jQuery-UI](http://jqueryui.com/) ([MIT](burpui/static/jquery-ui/MIT-LICENSE.txt))
+- [fancytree](https://github.com/mar10/fancytree) ([MIT](burpui/static/fancytree/MIT-LICENSE.txt))
+- [bootstrap](http://getbootstrap.com/) ([MIT](burpui/static/bootstrap/LICENSE))
+- [typeahead](http://twitter.github.io/typeahead.js/) ([MIT](burpui/static/typeahead/LICENSE))
+- [bootswatch](http://bootswatch.com/) ([MIT](burpui/static/bootstrap/bootswatch.LICENSE))
 
 Also note that this project is made with the Awesome [Flask](http://flask.pocoo.org/) micro-framework.
 

README.rst

+Build Status
+------------
+
+.. image:: http://ci.ziirish.me/projects/1/status.png?ref=master
+    :target: http://ci.ziirish.me/projects/1?ref=master
+
+Requirements
+------------
+
+For LDAP authentication (optional), we need the ``simpleldap`` module that 
+requires the following packages on Debian:
+
+::
+
+    aptitude install libsasl2-dev libldap2-dev python-dev
+
+
+Then we install the module itself:
+
+::
+
+    pip install simpleldap
+
+
+Installation
+------------
+
+Burp-UI is written in Python with the `Flask`_ micro-framework.
+The easiest way to install Flask is to use ``pip``.
+
+On Debian, you can install ``pip`` with the following command:
+
+::
+
+    aptitude install python-pip
+
+
+Once ``pip`` is installed, you can install ``Flask`` and the other requirements this
+way:
+
+::
+
+    pip install Flask
+    pip install flask-login
+    pip install WTForms
+    pip install Flask-WTF
+
+
+Then you need to download the sources.
+
+For example:
+
+::
+
+    git clone http://git.ziirish.me/ziirish/burp-ui.git
+
+
+You can setup various parameters in the `burpui.cfg`_ file.
+
+Then you can run ``burp-ui``: ``python burp-ui.py``
+
+By default, ``burp-ui`` listens on all interfaces (including IPv6) on port 5000.
+
+You can then point your browser to http://127.0.0.1:5000/
+
+Notes
+-----
+
+Please feel free to report any issues on my `gitlab <https://git.ziirish.me/ziirish/burp-ui/issues>`_
+I have closed the *github tracker* to have a unique tracker system.
+
+TODO
+----
+
+Here is a non-exhaustive list of things I'd like to add:
+
+* server-initiated restoration (with burp, you can create a special file that triggers a restoration when the client contacts the server the next time. In this case the client must accepts server-initiated restoration).
+* burp-server configuration front-end (so that you can configure your burp server within burp-ui).
+* More statistics.
+* etc.
+
+Also note that in the future, I'd like to write a burp-client GUI.
+But I didn't think yet of what to do.
+
+Licenses
+--------
+
+Burp-UI is released under the BSD 3-clause `License`_.
+
+But this project is built on top of other tools listed here:
+
+- `d3.js <http://d3js.org/>`_ (`BSD <http://git.ziirish.me/ziirish/burp-ui/blob/master/burpui/static/d3/LICENSE>`_)
+- `nvd3.js <http://nvd3.org/>`_ (`Apache <http://git.ziirish.me/ziirish/burp-ui/blob/master/burpui/static/nvd3/LICENSE.md>`_)
+- `jQuery <http://jquery.com/>`_ (`MIT <http://git.ziirish.me/ziirish/burp-ui/blob/master/burpui/static/jquery/MIT-LICENSE.txt>`_)
+- `jQuery-UI <http://jqueryui.com/>`_ (`MIT <http://git.ziirish.me/ziirish/burp-ui/blob/master/burpui/static/jquery-ui/MIT-LICENSE.txt>`_)
+- `fancytree <https://github.com/mar10/fancytree>`_ (`MIT <http://git.ziirish.me/ziirish/burp-ui/blob/master/burpui/static/fancytree/MIT-LICENSE.txt>`_)
+- `bootstrap <http://getbootstrap.com/>`_ (`MIT <http://git.ziirish.me/ziirish/burp-ui/blob/master/burpui/static/bootstrap/LICENSE>`_)
+- `typeahead <http://twitter.github.io/typeahead.js/>`_ (`MIT <http://git.ziirish.me/ziirish/burp-ui/blob/master/burpui/static/typeahead/LICENSE>`_)
+- `bootswatch <http://bootswatch.com/>`_ (`MIT <http://git.ziirish.me/ziirish/burp-ui/blob/master/burpui/static/bootstrap/bootswatch.LICENSE>`_)
+
+Also note that this project is made with the Awesome `Flask`_ micro-framework.
+
+Thanks
+------
+
+Special Thanks to Graham Keeling for its great software! This project would not
+exist without `Burp`_.
+
+.. _Flask: http://flask.pocoo.org/
+.. _License: http://git.ziirish.me/ziirish/burp-ui/blob/master/LICENSE
+.. _Burp: http://burp.grke.org/
+.. _burpui.cfg: http://git.ziirish.me/ziirish/burp-ui/blob/master/burpui.cfg

VERSION

-0.0.1
+0.0.2

setup.py

@@ -24,15 +24,17 @@ if sys.argv[-1] == 'publish':
 
 setup(
     name='burp-ui',
-    version=open('VERSION').read(),
+    version=open('VERSION').read().rstrip(),
     description=u('Burp-UI is a web-ui for burp backup written in python with Flask and jQuery/Bootstrap'),
-    long_description=open('README.md').read(),
+    long_description=open('README.rst').read(),
     license=open('LICENSE').read(),
     author=u('Benjamin SANS (Ziirish)'),
     author_email=u('ziirish@ziirish.info'),
-    url='https://github.com/ziirish/burp-ui',
+    url='http://git.ziirish.me/ziirish/burp-ui',
     keywords='burp web ui',
     packages=['burpui'],
+    scripts=['bin/burp-ui'],
+    py_modules=['burpui'],
     install_requires=['Flask==0.10.1', 'Flask-Login==0.2.11', 'Flask-WTF==0.10.0', 'WTForms==2.0.1'],
     extras_require={
         'ldap_authentication': ['simpleldap==0.8']