Metadata-Version: 2.1
Name: porfavor
Version: 0.5.1
Summary: Publishing static documentation the easy way
Home-page: https://github.com/osherdp/porfavor
Author: osherdp
Author-email: osherdepaz@gmail.com
License: UNKNOWN
Description: Por favor
        =========
        
        [![PyPI](https://badge.fury.io/py/porfavor.svg)](https://pypi.python.org/pypi/porfavor)
        [![Build Status](https://travis-ci.com/osherdp/porfavor.svg?branch=master)](https://travis-ci.com/osherdp/porfavor)
        
        Publishing static documentation the easiest way possible!
        
        Install
        -------
        
        ```shell
        $ pip install porfavor
        ```
        
        Use
        ---
        
        On the server side, you should run the matching server-side implementation.
        It listens to any client and puts the given documentation in its right place.
        
        On the server, run:
        ```shell
        $ pip install porfavor
        $ porfavor serve .  # replace '.' with the desired working directory
        ```
        
        Now, to deploy documentation on the server, all you have to do is running
        ```porfavor publish``` with the right arguments:
        
        ```shell
        $ # porfavor publish <server's URL> \
        >                    <project name> \
        >                    <documentation root>
        $ porfavor publish localhost:5000 my_amazing_project docs/_build/html/
        Zipping content of folder 'docs/_build/html'... DONE!
        Publishing content for project 'my_amazing_project'... DONE!
        ```
        
        Alternatively, you can write the following script, to make deployment more
        automatic:
        
        ```python
        from porfavor import publish
        
        if __name__ == '__main__':
            publish(host="localhost:5000",
                    project="project_name",
                    root_dir="root_dir")
        ```
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*
Description-Content-Type: text/markdown
Provides-Extra: dev
