Skip to main content

A humorous cucumber-themed Python utility library

Project description

Kheera Quick Reference

Use this condensed sheet when you just need the highlights—features, callable functions, CLI switches, and HTTP endpoints.

Features

  • Cucumber-themed core utilities for slicing, cooling, throwing, and general freshness fun.
  • Built-in ASCII art and Matplotlib rendering (draw) that outputs PNG bytes on demand.
  • Deterministic error codes (e.g., KHEERA-SLICE-002, KHEERA-CUCIFY-413) for resilient automation.
  • Ready-to-run FastAPI backend with JSON responses plus a /kheera/draw PNG endpoint.
  • Lightweight CLI shipping as the kheera console script.

Python Functions (kheera package)

  • draw(return_bytes: bool = False) -> Optional[bytes]
  • slice(count: int = 5) -> List[str]
  • cool_down(temp: int = 10) -> str
  • rate_kheera() -> str
  • is_fresh() -> str
  • throw(target: str) -> str
  • calculate_coolness(name: str) -> str
  • cucumberify(text: str) -> str
  • yoga_mode() -> str
  • health_status() -> HealthStatus
  • ascii_art() -> str

Custom Exceptions (kheera.errors)

  • KheeraError(code, message, status_code)
  • InvalidSliceCountError
  • CoolingNotEffectiveError
  • TargetNotFoundError
  • TextTooLargeError
  • RottenCucumberError

CLI Commands

kheera --help
kheera --version
kheera --draw
kheera --slice <n>

REST Endpoints (default host: http://localhost:8000)

  • GET / → API heartbeat
  • GET /kheera/slice?count=<int>
  • GET /kheera/cool_down?temp=<int>
  • GET /kheera/rate
  • GET /kheera/fresh
  • GET /kheera/throw?target=<str>
  • GET /kheera/coolness?name=<str>
  • POST /kheera/cucumberify ({"text": "..."})
  • GET /kheera/yoga
  • GET /kheera/ascii
  • GET /kheera/draw
  • GET /kheera/health
  • GET /kheera/error_codes

Useful Locations

  • Package entry point: kheera/__init__.py
  • CLI module: kheera/cli.py
  • Error catalogue: docs/errors.md
  • API root: backend/app.py
  • Router definitions: backend/routers/

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

kheera-0.1.1.tar.gz (10.5 kB view details)

Uploaded Source

Built Distribution

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

kheera-0.1.1-py3-none-any.whl (7.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for kheera-0.1.1.tar.gz
Algorithm Hash digest
SHA256 eb4a321a5f7de4a07a0cccb0f08333b5ebfc98bcd4dd5bca20b04d02af0ae4d4
MD5 bc81fea50666e43b0a3d604983db1034
BLAKE2b-256 0168af3b3dd1389ddaf4a80dea6996ddc80a565dd2007d80c2bde90a56a37dc3

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for kheera-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 32a0e4497c14c142567f32fe849046704d60f8fd64458b8e375605fa11d1c1f8
MD5 7804eb5121ef63f2f8a412c785d19bdd
BLAKE2b-256 f8ad52d5c8a03e5be4967e8bac94040beb00218e94cbf7fa3387094a31d53f25

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