prepared package for pypi

savon-noir · savon-noir · commit e1c00a55004b · 2013-06-08T18:15:58.000+02:00
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,2 +1,2 @@
-include *.txt
-recursive-include docs *.txt
+include TODO
+recursive-include docs *.txt *.md *.rst
diff --git a/README.md b/README.md
diff --git a/README.rst b/README.rst
@@ -0,0 +1,90 @@
+python-libnmap
+==============
+
+Code status
+-----------
+
+|Build Status|
+
+Use cases
+---------
+
+libnmap is a python library enabling python developpers to manipulate nmap process and data.
+
+libnmap is what you were looking for if you need to implement the following:
+
+    - automate or schedule nmap scans on a regular basis
+    - manipulate nmap scans results to do reporting for instance
+    - compare and diff nmap scans to generate graphs for instance
+    - batch process scan reports
+    - ...
+
+The above uses cases will be easy to implement with the help of the libnmap modules.
+
+libnmap modules
+---------------
+
+The lib currently offers the following modules:
+
+    - process: enables you to launch nmap scans
+    - parse: enables you to parse nmap reports or scan results (only XML so far) from a file, a string,...
+    - report: enables you to manipulate a parsed scan result and de/serialize scan results in a json format
+    - diff: enables you to see what changed between two scans
+    - common: contains basic nmap objects like NmapHost and NmapService. It is to note that each object can be "diff()ed" with another similar object.
+    - plugins: enables you to support datastores for your scan results directly in the "NmapReport" object from report module:
+    
+        - mongodb: only plugin implemented so far, ultra basic, for POC purpose only
+        - sqlalchemy: on-going
+        - csv: todo (easy to implement)
+        - elastic search: todo
+
+Documentation
+-------------
+
+All the documentation is available on `read the docs`_. This documentation contains small code samples that you directly reuse.
+
+Dependencies
+------------
+
+libnmap has by default no dependencies.
+
+The only additional python modules you'll have to install depends if you wish to use libnmap to store reports on an exotic data store via libnmap's independents plugins.
+
+Below the list of optional dependencies:
+
+    - sqlite3
+    - pymongo
+
+Install
+-------
+
+You can install libnmap via pip:
+
+```
+    pip install libnmap
+```
+
+or via git:
+
+```
+    $ git clone https://github.com/savon-noir/python-libnmap.git
+    $ cd python-libnmap
+    $ python setup.py install
+```
+
+Examples
+--------
+
+Some codes samples are available in the examples directory or in the `documentation`_.
+
+Contributors
+------------
+
+Mike @bmx0r Boutillier for S3 and SQL-Alechemy plugins and for the constructive critics. Thanks!
+
+.. |Build Status| image:: https://travis-ci.org/savon-noir/python-libnmap.png?branch=master
+   :target: https://travis-ci.org/savon-noir/python-libnmap
+
+.. _read the docs: https://libnmap.readthedocs.org
+
+.. _documentation: https://libnmap.readthedocs.org
diff --git a/TODO b/TODO
@@ -1,5 +1,8 @@
 - review and improve threading for NmapProcess
 - complete unit tests
+- XML interface to support both ElementTree and lxml APIs
+- support for python3
+- support for windows
 - Add new plugins to support import/export from mysql, couchdb, csv
 - support iterators for NmapReport::hosts
 - add unittest for udp scans, ping sweeping
diff --git a/setup.py b/setup.py
@@ -1,14 +1,23 @@
 from distutils.core import setup
 
+with open("README.rst") as rfile:
+    long_description = rfile.read()
+
 setup(
-    name='libnmap',
+    name='python-libnmap',
     version='0.2.1',
     author='Ronald Bister',
     author_email='mini.pelle@gmail.com',
     packages=['libnmap', 'libnmap.plugins', 'libnmap.test'],
     url='http://pypi.python.org/pypi/libnmap/',
     license='LICENSE.txt',
-    description="""A Python NMAP librairy enabling you to launch nmap scans,
-                 parse and compare (diff) scan results""",
-    long_description=open('README.md').read(),
+    description=('A Python NMAP library enabling you to launch nmap scans',
+                 'parse and compare (diff) scan results'),
+    long_description=long_description
+    classifiers=["Development Status :: 5 - Production/Stable",
+                 "Environment :: Console",
+                 "Programming Language :: Python :: 2.6",
+                 "Programming Language :: Python :: 2.7",
+                 "Topic :: System :: Networking",
+                 "Topic :: Software Development :: Libraries :: Python Modules"],
 )
