joytide 0.0.3

A fun Python package by team_riptide with random playful helpers.

PyPI: https://pypi.org/project/joytide/

joytide

joytide is a small python package with random fun helpers to help de-stress after hours of serious coding. each function can be visually changed with different inputs. the main way to use it is the CLI.

team members

• Saud Alsheddy
• Omer Hortig
• Amy Liu
• Alfardil Alam
• Lucy Hartigan

install

requires python 3.10 or higher

pip install joytide
# if pip is not on PATH:
python -m pip install joytide
# windows:
py -m pip install joytide

CLI

Banner

print an ASCII banner.

usage

joytide banner TEXT [--border "*" ] [--padding 1] [--align left|center|right]
# if console script isn't on PATH:
python -m joytide banner TEXT --border "#" --padding 2 --align right
py -m joytide banner "team_riptide"   # windows

examples

joytide banner "hello"
joytide banner "team_riptide" --border "##"
joytide banner "left"  --padding 2 --align left
joytide banner "right" --border "<>" --align right

---

Art

Print ASCII art with a chosen theme and size.

Usage

joytide art [--theme animal|nature|tech|random] [--size small|large]
# if console script isn't on PATH:
python -m joytide art --theme animal --size large
py -m joytide art --theme tech  #windows

examples

joytide art
joytide art --theme animal
joytide art --theme nature --size large
joytide art --theme tech --size small
joytide art --theme random --size large

---

Put each of your functions here with examples

example program for all functions

a short demo that calls each function is in examples/demo.py.

python demo.py
py demo.py

how to contribute

we use pipenv for development.

python -m pip install --user pipenv
pipenv install --dev
pipenv install -e .
pipenv run python -m pytest -v

build the package manually if needed:

pipenv run python -m build .

testing

each function should have tests for a normal case, an edge case, and an invalid input case.

pipenv run python -m pytest -v

CI / CD

• pull requests run tests on python 3.11 and 3.12
• merges to main build the package and publish to PyPI using twine via GitHub Actions (pypa/gh-action-pypi-publish)

configuration

no environment variables or secret config files are required. no database or starter data is needed. works on mac, windows, and linux.