Skip to main content

Egyptian jokes library

Project description

egyJokes 🎭

A simple Python package that returns random Egyptian jokes.

This is my first Python package, created to learn how to build, publish, and distribute a package on PyPI. The project is simple and made for practice while also providing a collection of Egyptian jokes.

Features

  • Get a random joke
  • Get multiple random jokes
  • Get a random joke from a category
  • Search jokes by keyword
  • Get a joke by its ID
  • List all categories
  • Show statistics for categories
  • Access all jokes

Installation

Install the package from PyPI:

pip install egyJokes

Quick Start

import egyJokes.jokes as jokes

print(jokes.random_joke())

Available Functions

Function Description
random_joke() Return one random joke
random_jokes(count) Return multiple random jokes
random_by_category(category) Return a random joke from a category
search(keyword) Search jokes by keyword
get(id) Return a joke by its ID
categories() Return all available categories
count() Return the total number of jokes
stats() Return the number of jokes in each category
jokes() Return all jokes

About This Project

This is a small personal project that I created to learn:

  • How to build a Python package
  • How to publish a package on PyPI
  • How to organize a Python project
  • How to work with JSON data
  • How to write package documentation

It is my first published Python package, so there is still room for improvement. I hope it can also help beginners who want to learn how Python packages work.


License

This project is licensed under the MIT License.


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

egyjokes-0.1.1.tar.gz (19.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

egyjokes-0.1.1-py3-none-any.whl (18.5 kB view details)

Uploaded Python 3

File details

Details for the file egyjokes-0.1.1.tar.gz.

File metadata

  • Download URL: egyjokes-0.1.1.tar.gz
  • Upload date:
  • Size: 19.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.0

File hashes

Hashes for egyjokes-0.1.1.tar.gz
Algorithm Hash digest
SHA256 5180a4f3ba41055228bf468e6e03a7c5dee73d698ba03f247b500cd27aba4a3e
MD5 99f6f4616b2bb2cfaf5be12a49959d5e
BLAKE2b-256 eef1593fb085e488fb1af46d5dacd31a0aabfba06e68557c41356aae744981d1

See more details on using hashes here.

File details

Details for the file egyjokes-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: egyjokes-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 18.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.0

File hashes

Hashes for egyjokes-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a97737484ac376fd2e1a8e312bf1401c48b6400cb8055f7cc060cf54013b27bd
MD5 6a92c900ba04b0af23b909cda1c7af13
BLAKE2b-256 9943eb16508b13cd3a530eb9f4202adbc632593c401c2d9b8bef1835cec0bd56

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page