| Name | chucklepy JSON |
| Version |
0.1.1
JSON |
| download |
| home_page | None |
| Summary | A lighthearted Python package that brings joy. |
| upload_time | 2025-03-19 00:33:06 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | MIT |
| keywords |
fun
comedy
puns
insults
lighthearted
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Python Package Exercise
# ChucklePy - A Fun Python Package
## What is ChucklePy?
**ChucklePy** is a fun Python package designed to bring humor to developers’ lives.
With puns, comedic insults, text amusement, and random fortunes, it keeps coding entertaining.
## Installation
Install ChucklePy directly from PyPI:
```bash
pip install chucklepy
```
Import the package in your code:
```python
from chucklepy import generate_pun, comedic_insult, amuseify_text, random_fortune
```
Usage Examples
Here’s how you can use ChucklePy in your Python scripts:
- Generate a Pun
```python
pun = generate_pun(category="tech", length="short")
print(pun)
“A SQL query walks into a bar, sees two tables, and asks: 'Can I join you?'”
```
- Generate a Comedic Insult
```python
insult = comedic_insult("Alice", severity=2)
print(insult)
“Alice, your code is like a maze — I've gone in circles three times and I'm still nowhere near an exit!”
```
- Amuseify Text
```python
fun_text = amuseify_text("Hello world!", style="emoji")
print(fun_text)
“Hello👾 world!”
```
- Get a Random Fortune
```python
from chucklepy import random_fortune
fortune = random_fortune(topic="career", mood="sarcastic")
print(fortune)
“Not writing bugs tonight only means writing double the bugs tomorrow.”
```
See more examples in the [example program](https://github.com/software-students-spring2025/3-python-package-httprequest/blob/main/src/chucklepy/example.py).
## PyPI package link
[Visit and try our fun package](https://pypi.org/project/chucklepy/0.1.0/)
## Contributing to ChucklePy
We love contributions! Here’s how you can set up the project locally:
### Clone the Repository
```bash
git clone https://github.com/software-students-spring2025/3-python-package-httprequest.git
```
### Set Up Virtual Environment
- Using Pipenv:
```bash
pipenv install --dev
pipenv shell
```
- Run Tests
```bash
pipenv run pytest
cd src
pytest tests
```
- Build and Install the Package Locally
```bash
pipenv run python -m build
pip install dist/chucklepy-*.whl
```
## Team Members
- Xiaowei Ma [GitHub](https://github.com/WillliamMa)
- Rishi Rana [GitHub](https://github.com/Rishi-Rana1)
- Mandy Mao [GitHub](https://github.com/manrongm)
- Weite Li [Github](https://github.com/YYukin0)
## Running the Project on Any Platform
- Ensure Python 3.9+ is installed
- Clone the repository
- Install dependencies
- Run tests
- Execute the example script
Raw data
{
"_id": null,
"home_page": null,
"name": "chucklepy",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "fun, comedy, puns, insults, lighthearted",
"author": null,
"author_email": "Xiaowei Ma <xm2212@nyu.edu>, Weite Li <wl2811@nyu.edu>, Mandy Mao <mm13721@nyu.edu>, Rishi Rana <rr4211@nyu.edu>",
"download_url": "https://files.pythonhosted.org/packages/5c/c1/89298e613b0eb869fd4d7436a9b67af32e968bbb9706f32ee2e141401219/chucklepy-0.1.1.tar.gz",
"platform": null,
"description": "# Python Package Exercise\n\n# ChucklePy - A Fun Python Package\n\n## What is ChucklePy?\n**ChucklePy** is a fun Python package designed to bring humor to developers\u2019 lives. \nWith puns, comedic insults, text amusement, and random fortunes, it keeps coding entertaining. \n\n## Installation\nInstall ChucklePy directly from PyPI:\n```bash\npip install chucklepy\n```\nImport the package in your code:\n\n```python\nfrom chucklepy import generate_pun, comedic_insult, amuseify_text, random_fortune\n```\nUsage Examples \nHere\u2019s how you can use ChucklePy in your Python scripts:\n\n- Generate a Pun\n```python\npun = generate_pun(category=\"tech\", length=\"short\")\nprint(pun)\n\u201cA SQL query walks into a bar, sees two tables, and asks: 'Can I join you?'\u201d\n```\n- Generate a Comedic Insult\n```python\ninsult = comedic_insult(\"Alice\", severity=2)\nprint(insult)\n\u201cAlice, your code is like a maze \u2014 I've gone in circles three times and I'm still nowhere near an exit!\u201d\n```\n- Amuseify Text\n```python\nfun_text = amuseify_text(\"Hello world!\", style=\"emoji\")\nprint(fun_text)\n\u201cHello\ud83d\udc7e world!\u201d\n```\n- Get a Random Fortune\n```python\nfrom chucklepy import random_fortune\n\nfortune = random_fortune(topic=\"career\", mood=\"sarcastic\")\nprint(fortune)\n\u201cNot writing bugs tonight only means writing double the bugs tomorrow.\u201d\n```\nSee more examples in the [example program](https://github.com/software-students-spring2025/3-python-package-httprequest/blob/main/src/chucklepy/example.py).\n\n## PyPI package link\n\n[Visit and try our fun package](https://pypi.org/project/chucklepy/0.1.0/)\n## Contributing to ChucklePy \nWe love contributions! Here\u2019s how you can set up the project locally:\n\n### Clone the Repository\n```bash\ngit clone https://github.com/software-students-spring2025/3-python-package-httprequest.git\n```\n### Set Up Virtual Environment \n- Using Pipenv:\n```bash\npipenv install --dev\npipenv shell\n```\n- Run Tests\n```bash\npipenv run pytest\ncd src\npytest tests\n```\n- Build and Install the Package Locally\n```bash\npipenv run python -m build\npip install dist/chucklepy-*.whl\n```\n## Team Members \n\n- Xiaowei Ma [GitHub](https://github.com/WillliamMa)\n- Rishi Rana [GitHub](https://github.com/Rishi-Rana1)\n- Mandy Mao [GitHub](https://github.com/manrongm)\n- Weite Li [Github](https://github.com/YYukin0)\n\n## Running the Project on Any Platform \n- Ensure Python 3.9+ is installed \n- Clone the repository \n- Install dependencies\n- Run tests \n- Execute the example script\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A lighthearted Python package that brings joy.",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/software-students-spring2025/3-python-package-httprequest"
},
"split_keywords": [
"fun",
" comedy",
" puns",
" insults",
" lighthearted"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "6447bb5b3839a434f0de6b9a749cff6b57b435313bca2ecc46d82c46f1576f30",
"md5": "5405341fb1382caf799103040efe5161",
"sha256": "19f31fb63fe0a4067d679aaccc0cc612155bcc452c7f2886b90fdc382786ce2a"
},
"downloads": -1,
"filename": "chucklepy-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5405341fb1382caf799103040efe5161",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 19932,
"upload_time": "2025-03-19T00:33:04",
"upload_time_iso_8601": "2025-03-19T00:33:04.214536Z",
"url": "https://files.pythonhosted.org/packages/64/47/bb5b3839a434f0de6b9a749cff6b57b435313bca2ecc46d82c46f1576f30/chucklepy-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "5cc189298e613b0eb869fd4d7436a9b67af32e968bbb9706f32ee2e141401219",
"md5": "769d0e7a785f7244124a0e9786030eac",
"sha256": "f5acd72c14e1385ddfb7f6fa75f61c4ef08c5b3be8bdd9865774f15a5c63b182"
},
"downloads": -1,
"filename": "chucklepy-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "769d0e7a785f7244124a0e9786030eac",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 19274,
"upload_time": "2025-03-19T00:33:06",
"upload_time_iso_8601": "2025-03-19T00:33:06.037827Z",
"url": "https://files.pythonhosted.org/packages/5c/c1/89298e613b0eb869fd4d7436a9b67af32e968bbb9706f32ee2e141401219/chucklepy-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-19 00:33:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "software-students-spring2025",
"github_project": "3-python-package-httprequest",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "chucklepy"
}
