Skip to content

Commit

Permalink
fixed rst file
Browse files Browse the repository at this point in the history
  • Loading branch information
savon-noir committed Jun 8, 2013
1 parent e2ccbe2 commit bf69d4e
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 26 deletions.
44 changes: 20 additions & 24 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 13,11 @@ libnmap is a python library enabling python developpers to manipulate nmap proce

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
- ...
- 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.

Expand All @@ -26,17 26,17 @@ 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
- 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
-------------
Expand All @@ -52,25 52,21 @@ The only additional python modules you'll have to install depends if you wish to

Below the list of optional dependencies:

- sqlite3
- pymongo
- sqlite3
- pymongo

Install
-------

You can install libnmap via pip:
You can install libnmap via pip::

```
pip install libnmap
```

or via git:
or via git::

```
$ git clone https://github.com/savon-noir/python-libnmap.git
$ cd python-libnmap
$ python setup.py install
```

Examples
--------
Expand Down
3 changes: 1 addition & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 18,5 @@
"Environment :: Console",
"Programming Language :: Python :: 2.6",
"Programming Language :: Python :: 2.7",
"Topic :: System :: Networking",
"Topic :: Software Development :: Libraries :: Python Modules"],
"Topic :: System :: Networking"]
)

0 comments on commit bf69d4e

Please sign in to comment.