Metadata-Version: 1.1
Name: axju-jokes
Version: 1.0.1
Summary: Jokes for python
Home-page: https://github.com/axju/joke
Author: Axel Juraske
Author-email: axel.juraske@short-report.de
License: MIT
Description: ====
        joke
        ====
        Jokes for python.
        
        I was really sad, no package called joke. So I decided to create one, really
        fast. This package have some functions, that return some jokes, quotes or facts.
        If you are sad, use the joke packages. :)
        
        Install
        -------
        ::
        
          pip install axju-jokes
        
        
        Command line
        ------------
        You can exit the function from the command line. There are two entry points:
        
        .. code-block:: shell
        
          $ joke
          $ python -m joke
        
        With no arguments, it will return a random joke, quote or fact. You can set one
        specifically API. For example some cat facts:
        
        .. code-block:: shell
        
          $ joke cat
        
        Use help to see the possible API's:
        
        .. code-block:: shell
        
          $ joke --help
        
        Examples
        --------
        Some jokes examples
        
        .. code:: python
        
          from joke.jokes import *
          # This will import all joke-functions (geek, icanhazdad, chucknorris, icndb)
          # Now you can use them to get some jokes.
        
          # For example you can display 10 Chuck Norris jokes.
          for i in range(10):
              print(chucknorris())
        
          # Or get a random joke-function.
          from random import choice
          print(choice([geek, icanhazdad, chucknorris, icndb])())
        
        Some quotes examples
        
        .. code:: python
        
          from joke.quotes import *
        
          # get a quote from quotesondesign.com
          print(quotesondesign())
        
          # you can get more then one with one request
          for quote in quotesondesign(5):
              print(quote)
        
          # and you can get the data
          data = quotesondesign(format='data')
          print(data['quote'])
          print(data['author'])
        
        
          # get quote from stormconsultancy.co.uk
          print(stormconsultancy())
        
          # You can set the ID to get a specific quote
          print(stormconsultancy(id=2))
        
          # the stormconsultancy-function give you also the data
          data =stormconsultancy(id=2, format='data')
          print(data['quote'])
          print(data['author'])
        
        Check also the example folder.
        
        Import Easter Egg
        -----------------
        ::
        
          >>> import joke.eggs
          Chuck Norris has to register every part of his body as a separate lethal weapon.
          His spleen is considered a concealed weapon in over 50 states.
        
        API's
        -----
        To get the jokes, I use some open API's. If you know some missing API's, please
        contact me. Until now, the following API's are used.
        
        - https://geek-jokes.sameerkumar.website/api
        - https://icanhazdadjoke.com/
        - https://api.chucknorris.io/jokes/random
        - http://api.icndb.com/jokes/random/
        - http://quotesondesign.com/wp-json/posts
        - http://quotes.stormconsultancy.co.uk
        - https://cat-fact.herokuapp.com/facts/random
        
        
        Development
        -----------
        Clone repo::
        
          git clone https://github.com/axju/joke.git
        
        Create virtual environment and update dev-tools::
        
          python3 -m venv venv
          source venv/bin/activate
          pip install --upgrade wheel pip setuptools twine tox
        
        Install local::
        
          pip install -e .
        
        Run some tests::
        
          tox
          python -m unittest discover
          python setup.py test
        
        Publish the packages::
        
          python setup.py sdist bdist_wheel
          twine upload dist/*
        
Keywords: joke fun funny
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Internet
Classifier: Environment :: Console
