{ "info": { "author": "Donovan du Plessis", "author_email": "donovan@binarytrooper.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 1 - Planning", "Environment :: Web Environment", "Framework :: Flask", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python :: 2.7", "Topic :: Internet :: WWW/HTTP :: Dynamic Content" ], "description": "******************************\nPWNurl: url shortening service\n******************************\n\n.. image:: https://badge.fury.io/py/pwnurl.png\n :target: http://badge.fury.io/py/pwnurl\n\n.. image:: https://travis-ci.org/donovan-duplessis/pwnurl.png?branch=master\n :target: https://travis-ci.org/donovan-duplessis/pwnurl\n\n**Table of Contents**\n\n\n.. contents::\n :local:\n :depth: 1\n :backlinks: none\n\n=============\nMain Features\n=============\n\n* TODO\n\n============\nInstallation\n============\n\nThe **latest stable version** can always be installed or updated to via `pip`_:\n\n.. code-block:: bash\n\n $ pip install --upgrade pwnurl\n\n\nThe **latest development version** can be installed directly from GitHub:\n|travis-master|\n\n.. |travis-master| image:: https://travis-ci.org/donovan-duplessis/pwnurl.png?branch=master\n :target: https://travis-ci.org/donovan-duplessis/pwnurl\n :alt: Build Status of the master branch\n\n\n.. code-block:: bash\n\n $ pip install --upgrade https://github.com/donovan-duplessis/pwnurl/tarball/master\n\n=============\nConfiguration\n=============\n\nYou need to set the ``PWNURL_SETTINGS`` environment variable to point to the\nconfiguration file:\n\n.. code-block:: bash\n\n $ export PWNURL_SETTINGS=~/.pwnurlrc\n\nThe following configuration parameters are vailable:\n\n+-------------------------+-----------------------------------------------------------------+\n| Parameter | Description |\n+=========================+=================================================================+\n| HOST | Hostname or ip address to bind server on |\n| ``name=string`` | e.g. ``HOST = '0.0.0.0'`` |\n+-------------------------+-----------------------------------------------------------------+\n| PORT | Port number to bin server on |\n| ``name=integer`` | e.g. ``PORT = 5001`` |\n+-------------------------+-----------------------------------------------------------------+\n| SECRET_KEY | Secret application key/token |\n| ``name=sring`` | e.g. ``SECRET_KEY = 'yU2Tz4PVMVWlDNceFuH'`` |\n+-------------------------+-----------------------------------------------------------------+\n| CACHE_TYPE | Caching implementation (simple|memcached|redis) |\n| ``name=string``, | e.g. ``CACHE_TYPE = 'simple'`` |\n+-------------------------+-----------------------------------------------------------------+\n| SQLALCHEMY_DATABASE_URI | Database connection string |\n| ``name=string`` | e.g. ``SQLALCHEMY_DATABASE_URI = 'sqlite:////tmp/pwnurl.db'`` |\n+-------------------------+-----------------------------------------------------------------+\n\n=====\nUsage\n=====\n\n\nInitialize Database:\n\n.. code-block:: bash\n\n $ pwnurl db upgrade\n\nCompile Web Assets:\n\n.. code-block:: bash\n\n $ pwnurl assets clean\n $ pwnurl assets build\n\nStart Gunicorn Server:\n\n.. code-block:: bash\n\n $ pwnurl gunicorn [--daemon]\n\nStop Gunicorn Server:\n\n.. code-block:: bash\n\n $ kill -TERM `cat /tmp/pwnurl.pid`\n\n=======\nAuthors\n=======\n\n`Donovan du Plessis`_ (`@binarytrooper`_)\n\n=======\nLicence\n=======\n\nPlease see `LICENSE`_.\n\n------\n\n.. _pip: http://www.pip-installer.org/en/latest/index.html\n.. _Donovan du Plessis: http://binarytrooper.com\n.. _@binarytrooper: https://twitter.com/binarytrooper\n.. _AUTHORS.rst: https://github.com/donovan-duplessis/pwnurl/blob/master/AUTHORS.rst\n.. _LICENSE: https://github.com/donovan-duplessis/pwnurl/blob/master/LICENSE\n\n\n.. :changelog:\n\nHistory\n-------\n\n0.1.0 (2014-01-15)\n++++++++++++++++++\n\n* First release on PyPI.", "description_content_type": null, "docs_url": null, "download_url": "UNKNOWN", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://github.com/donovan-duplessis/pwnurl", "keywords": "url shortener", "license": "BSD", "maintainer": null, "maintainer_email": null, "name": "pwnurl", "package_url": "https://pypi.org/project/pwnurl/", "platform": "any", "project_url": "https://pypi.org/project/pwnurl/", "project_urls": { "Download": "UNKNOWN", "Homepage": "http://github.com/donovan-duplessis/pwnurl" }, "release_url": "https://pypi.org/project/pwnurl/0.1.0/", "requires_dist": null, "requires_python": null, "summary": "PWNurl Url Shortener (pwn that url!)", "version": "0.1.0" }, "last_serial": 1063278, "releases": { "0.1.0": [] }, "urls": [] }