FIX: Adds register method

README.md

@@ -62,6 +62,15 @@ Or, you can scale the icon with respect to its default dimensions like this:
 ```
 
 
+If you want your own icon, you can register it globally and then use it.
+Register the icon like this:
+```
+from octicons.templatetags.octicons import Octicon
+Octicon.register(<icon_name>, <path_to_icon>)
+```
+The icon's height and widht must be 24 pixels.
+
+
 All attributes passed will be added as HTML attributes to the SVG element
 of the icon.
 

octicons/templatetags/octicons.py

@@ -4,6 +4,7 @@
 
 from django import template
 from django.utils.html import format_html
+from xml.dom import minidom
 
 from . import OCTICON_DATA
 
@@ -102,6 +103,26 @@ def _calculate_height(self, width):
         return int((int(width) * self.height) / self.width)
 
 
+    # Register method for a new icon.
+    @classmethod
+    def register(cls, symbol, svg_file):
+        doc = minidom.parse(svg_file)
+        path_strings = [path.getAttribute('d') for path
+                        in doc.getElementsByTagName('path')]
+        path = '<path fill-rule="evenodd" d="'+path_strings[0]+'"'+"/>"
+
+        values = {
+        'name': symbol,
+        'keywords': [symbol],
+        'width': 24,
+        'height': 24,
+        'path': path
+        }
+
+        OCTICON_DATA.update({symbol:values})
+        doc.unlink()
+
+
 @register.simple_tag
 def octicon(symbol, **options):
     icon = Octicon(symbol, **options)

tests/test_octicon.py

@@ -1,7 +1,9 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 import pytest
+from octicons.templatetags import OCTICON_DATA
 from octicons.templatetags.octicons import Octicon
+import os.path
 
 
 def test_failure_when_octicon_not_exist():
@@ -96,3 +98,11 @@ def test_a11y_include_attributes():
 def test_a11y_has_aria_hidden_when_no_label_passed():
     icon = Octicon('x')
     assert 'aria-hidden="true"' in icon.to_svg
+
+
+# Test for the register method
+def test_register_octicon():
+    my_path = os.path.abspath(os.path.dirname(__file__))
+    path = os.path.join(my_path, "icon/pen.svg")
+    Octicon.register('pen', path)
+    assert OCTICON_DATA.get('pen')