Metadata-Version: 1.1
Name: polished
Version: 0.0.1
Summary: Generates screenshots of a website based on git history
Home-page: https://github.com/ckcollab/polished
Author: Eric Carmichael
Author-email: eric@ckcollab.com
License: MIT
Description: polished
        ========
        
        [![Polished example video](http://img.youtube.com/vi/yBTDiGhJjlo/0.jpg)](http://www.youtube.com/watch?v=yBTDiGhJjlo)
        
        The goal of polished is to show the awesome progression and amount of tweaks that go into any website. My [resume](http://ericcarmichael.com)
        is a good example, dozens of hours of work and tweaking to come up with this pretty basic final product. Showing that
        blood, sweat and hilarious tears in between should be pretty entertaining. Watch pages undulate, stretch, break,
        grow, and shrink into place.
        
        ### How does it work?
        
        Once you've installed polished, it works like this:
        
        1. Fires up selected backend (for example, PelicanBackend if you use the [Pelican]() blog site generator)
        2. Get the history of your git repo
        3. Iterate through that history, preparing each page and finally screen cap it
        
        
        Getting started
        ===============
        
        THIS ONLY WORKS ON MAC!
        
        ### Installing
        
        **Requirements**
        
        1. NodeJS
        2. PhantomJS
        3. ffmpeg
        
        Then
        
        ```
        > pip install polished
        ```
        
        ### Usage
        
        For a static website with no .html generation needed and `index.html` is in the same dir:
        
        ```
        > polished
        ```
        
        For a static website with `index.html` in another location
        
        ```
        > polished "some/path/to/index.html"
        ```
        
        For a pelican blog:
        
        ```
        > polished "output/index.html" --backend polished.backends.pelican.PelicanBackend
        ```
        
        
        ### Configuring behavior
        
        The default backend is `SimpleBackend` which (with no path specified) looks for "index.html" in current directory and
        expects static html without any steps needed to generate the page. This default setup probably doesn't work for most setups.
        
        To expand the behavior, call `polished --backend my.backend.Backend`
        
        
        ### Basic available backends
        
        ```
        polished.backends.simple.SimpleBackend()
        ```
        
        The most basic backend, assumes no steps are needed to generate HTML.
        
        ```
        polished.backends.pelican.PelicanBackend()
        ```
        
        For the Pelican blogging system, calls `make html` between builds.
        
        ```
        polished.backends.django.DjangoBackend()
        ```
        
        For the Django framework, calls "syncdb --migrate"
        
        
        ## Custom backend
        
        Generally, on a simple website these backends will care of you, however you may have to
        inherit them and add custom behavior
        
        ```python
        import polished
        import subprocess
        
        class SomeWeirdBehaviorRequired(polished.backends.pelican):
            def prepare(self):
                '''
                Prepare your general stuff here! Generate HTML, setup static files, etc.
                '''
        
        
            def cleanup(self):
                '''
                Clean up after yourself, delete static files if you need to
                '''
                pass
        
            @polish(image=15, html="output/pages/about.html")
            def fix_broken_import(self):
                '''
                So you committed some broken img reference that is breaking image #15 (generally polished/00015.polished.png)
                '''
                all_a_tags = html.cssselect('a')
                for a in all_a_tags:
                    a.attrib["href"] = "some_other_url/%s" % a.attrib["href"]
        ```
        
        @polish(between_shas=("sha1", "sha2"))
        
        @polish(between_images=(1, 3))
        
        @polish(image=1)
        
        @polish(sha="sha")
        
        
        @skip(between_shas=("sha1", "sha2"))
        
        @skip(between_images=(1, 3))
        
        @skip(image=1)
        
        @skip(sha="sha")
        
        
        
        
        
        Acknowledgements
        ================
        Couldn't have done it without this [screenshot script](http://stackoverflow.com/a/18068097) by Aamir Adnan
        
        Thanks [Levi Thomason](https://github.com/levithomason) for always hearing, encouraging, and helping me out in all aspects of life
        
Keywords: link checker
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Topic :: Software Development :: Libraries :: Python Modules
