1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
.. image:: https://travis-ci.org/pyjokes/pyjokes.svg
:target: https://travis-ci.org/pyjokes/pyjokes
=======
pyjokes
=======
One line jokes for programmers (jokes as a service)
Installation
============
Install the `pyjokes` module with pip.
See the `documentation`_ for installation instructions.
Usage
=====
Once installed, simply call `pyjoke` from the command line.
Alternatively use the `-c` flag to get jokes from a specific category. Options::
-c neutral [default] (neutral geek jokes)
-c adult (adult geek jokes)
-c chuck (Chuck Norris geek jokes)
-c all (all jokes)
You can also access the jokes in your own project by importing `pyjokes` and using the functions `get_joke` and `get_jokes`
Comprehensive documentation is available at `http://pyjoke.es`_
Contributors
============
Development:
* `Ben Nuttall`_
* `Alex Savio`_
* `Borja Ayerdi`_
* `Oier Etxaniz`_
Jokes:
* `Luke Wren`_
* `Sarah Bird`_
* `Yash Mehrotra`_
* `Marc Kirkwood`_
* `Gregory Parker`_
Contributing
============
* The code is licensed under the `BSD Licence`_
* The project source code is hosted on `GitHub`_
* Please use `GitHub issues`_ to submit bugs and report issues
* Feel free to `contribute`_ to the code
* Feel free to contribute jokes (via pull request or `proposal issue`_)
* See the `contributing policy`_ on GitHub
Tests
=====
Install requirements (pytest)
Run tests::
python setup.py test
Pyjokes Society
===============
This project is was founded at `PySS 2014`_ and is directed by the `Pyjokes Society`_.
.. _documentation: http://pyjoke.es/install/
.. _http://pyjoke.es: http://pyjoke.es
.. _Ben Nuttall: https://github.com/bennuttall
.. _Alex Savio: https://github.com/alexsavio
.. _Borja Ayerdi: https://github.com/borjaayerdi
.. _Oier Etxaniz: https://github.com/oiertwo
.. _Luke Wren: https://github.com/wren6991
.. _Sarah Bird: https://github.com/birdsarah
.. _Yash Mehrotra: https://github.com/yashmehrotra
.. _Marc Kirkwood: https://github.com/trojjer
.. _Gregory Parker: https://github.com/ElectronicsGeek
.. _BSD Licence: http://opensource.org/licenses/BSD-3-Clause
.. _GitHub: https://github.com/pyjokes/pyjokes
.. _GitHub Issues: https://github.com/pyjokes/pyjokes/issues
.. _contribute: https://github.com/pyjokes/pyjokes/tree/master/CONTRIBUTING.md
.. _proposal issue: https://github.com/pyjokes/pyjokes/issues/10
.. _contributing policy: https://github.com/pyjokes/pyjokes/tree/master/CONTRIBUTING.md
.. _PySS 2014: http://www.pyss.org/
.. _Pyjokes Society: http://pyjok.es/society/
|
