Metadata-Version: 2.0
Name: elevator-pitch-faker
Version: 0.2.0
Summary: An elevator pitch generator for the Faker Python package.
Home-page: https://github.com/jnyjny/elevator-pitch-faker
Author: Erik O'Shaughnessy
Author-email: erik.oshaughnessy@gmail.com
License: Apache License, Version 2.0
Description-Content-Type: UNKNOWN
Keywords: faker elevator pitch novel movie test data
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Utilities
Classifier: License :: OSI Approved :: Apache Software License
Requires-Dist: faker

Elevator Pitch Faker
====================

|pypi| |license| |python|

**elevator_pitch_faker** is a provider for the `Faker`_ Python package
which creates a humorous elevator pitch for your next novel/movie. Inspiration drawn from this `article`_.

Install
-------

Install with pip:

.. code:: bash

 $ pip install elevator-pitch-faker


Or install with setup.py:

.. code:: bash

 $ git clone https://github.com/jnyjny/elevator-pitch-faker.git
 $ cd elevator-pitch-faker && python3 setup.py install

Uninstall with pip:

.. code:: bash

	  $ pip uninstall elevator-pitch-faker

Usage
-----

Add the ``StoryPitchProvider`` to your ``Faker`` instance:

.. code:: python

	  from faker import Faker
	  from elevator_pitch_faker import StoryPitchProvider

	  fake = Faker()
	  fake.add_provider(StoryPitchProvider)

          print(fake.story_pitch())


View the methods defined by ElevatorPitchProvider:

.. code:: bash

  $ pydoc3 elevator_pitch.StoryPitchProvider


.. |pypi| image:: https://img.shields.io/pypi/v/elevator-pitch-faker.svg?style=flat-square&label=version
    :target: https://pypi.org/pypi/elevator-pitch-faker
    :alt: Latest version released on PyPi

.. |python| image:: https://img.shields.io/pypi/pyversions/elevator-pitch-faker.svg?style=flat-square
   :target: https://pypi.org/project/elevator-pitch-faker/
   :alt: Python Versions	  

.. |license| image:: https://img.shields.io/badge/license-apache-blue.svg?style=flat-square
    :target: https://github.com/jnyjny/elevator-pitch-faker/blob/master/LICENSE
    :alt: Apache license version 2.0  

.. _Faker: https://github.com/joke2k/faker

.. _Elevator Pitch: https://github.com/jnyjny/elevator-pitch-faker

.. _article: https://electricliterature.com/how-to-write-elevator-pitch-novel-publicity-infographic-a8ec74ecf7ce




