Metadata-Version: 2.1
Name: django-pygmento
Version: 0.2
Summary: django-pygmento is a syntax highlighter based on Pygments for django>=4.0.0
Home-page: https://github.com/apoorvaeternity/django-pygmento
Author: Apoorva Pandey
Author-email: apoorvapandey365@gmail.com
License: BSD License
Project-URL: Source, https://github.com/apoorvaeternity/django-pygmento
Project-URL: Bug Tracker, https://github.com/apoorvaeternity/django-pygmento/issues
Description: # django-pygmento
        > Syntax highlighter for django templates based on Pygments.
        
        
        ## Usage example
        - Install the package using
        ```bash
        pip install django-pygmento
        ```
        
        - Add `pygmento` to `INSTALLED_APPS` in your settings file.
        - Load `pygmento` template tag
        ```html
        {% load pygmento %}
        ```
        - Include pygment css in `head` using the `pygmento_css` template tag or manually generate it as described [here](https://pygments.org/docs/quickstart/#command-line-usage) and add it to static files. 
        ```html
        <head>
            {% pygmento_css %}
        </head>
        ```
        
        - Use `pygmento` as shown below
        ```
        # Single line code
        {{ "print('hello')"|pygmento:"python" }}
        
        # Multi-line code block in python
        {% pygmentoblock "python" %}
        class Dog:
            def __init__(self, name):
                self.name = name
                self.tricks = []    # creates a new empty list for each dog
        
            def add_trick(self, trick):
                self.tricks.append(trick)
        {% endpygmentoblock %}
        
        # Multi-line code block in html
        {% pygmentoblock "html" %}
        <!DOCTYPE html>
        <html>
        <body>
        <h1>My Heading</h1>
        <p>My paragraph.</p>
        </body>
        </html>
        {% endpygmentoblock %}
        ```
        
        The above code will get rendered as
        
        ![image info](./example.png)
        
        
        # Available styles
        Styles can be set using `PYGMENTO_STYLE` setting.
        ```python
        PYGMENTO_STYLE = "default"
        ```
        
        See the list of available styles and how they look [here](https://pygments.org/styles/). 
        
        
        ## Meta
        
        Apoorva Pandey – apoorvapandey365@gmail.com
        
        Distributed under the BSD license.
        
        [https://github.com/apoorvaeternity](https://github.com/apoorvaeternity)
        
        ## Contributing
        
        1. Fork it (<https://github.com/apoorvaeternity/django-pygmento/>)
        2. Create your feature branch (`git checkout -b feature/fooBar`)
        3. Commit your changes (`git commit -m 'Add some fooBar'`)
        4. Push to the branch (`git push origin feature/fooBar`)
        5. Create a new Pull Request
        
Keywords: syntax highlighter for django
Platform: any
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.9
Description-Content-Type: text/markdown
