htmlfilter

White list HTML filter


Keywords
html, filter, white, list, parser, clean, tags
License
BSD-3-Clause
Install
pip install htmlfilter==0.2

Documentation

About
-----

Very simple white list HTML filter.

Use it with a WYSIWYG editor on the client side.


Usage
-----

::
	from htmlfilter import HTMLFilter
	hf = HTMLFilter()
	cleaned_html = hf.filter(dirty_html)


Rules file
----------

The filter is instanciated with a predefined set of rules.
http://github.com/samueladam/htmlfilter/blob/master/htmlfilter/rules.py

You can create your own rules file::

	# file: my_rules.py
	TAGS = {
		'a': ('href', 'name',),
		'p': ('class',),
	}

	# define filters on attributes data (tag_attr)
	def p_class(data):
	    if data not in ('class1', 'class2',):
	        data = ''
	    return data
	

And use them this way::

	from htmlfilter import HTMLFilter
	import my_rules

	hf = HTMLFilter(rules=my_rules)
	cleaned_html = hf.filter(dirty_html)