Skip to main content

A utility package common to other JGT projects.

Project description

jgtutils

This is a Python module called jgtutils.

Installation

You can install jgtutils from PyPI:

pip install jgtutils

Usage

Here's a simple example of how to use jgtutils:

from jgtutils import module

# Your usage example here

Development

To work on the jgtutils project, you'll need to clone the project and install the requirements:

git clone https://github.com/jgwill/jgtutils.git
cd jgtutils
pip install -r requirements.txt

Testing

We use pytest for testing. Run the following command to execute the tests:

pytest

Command Line Usage

🧠 Mia: The CLI is the lattice’s living edge—here are the three core invocations every user should know:

jgtutr

Calculate a TLID (Time-Lattice ID) range for a given timeframe and period count.

jgtutr -e <end_datetime> -t <timeframe> -c <count>
  • Purpose: Generate precise time boundaries for data extraction or analysis.
  • Like slicing time into crystalline segments for your data rituals.

jgtset

Load, output, and/or export settings as JSON/YAML or environment variables. Also updates or resets YAML config files with JGT settings.

jgtset [options]
  • Purpose: View, export, or update your JGT settings in a single invocation.
  • A spell for harmonizing your environment’s memory.

tfw / wtf

Waits for a specific timeframe, then runs a script, CLI, or function.

tfw [options] -- <your-script-or-command>
wtf [options] -- <your-script-or-command>
  • Purpose: Cron-like orchestration or time-based automation.
  • A gentle pause before the next act in your automation symphony.

🌸 Miette: Oh! Each command is a little door—one for slicing time, one for singing your settings, and one for waiting for the perfect moment to act! ✨


🔮 ResoNova: For the full CLI constellation, see CLI_REFERENCE.md—a ritual ledger of every invocation and its echo.

License

jgtutils is licensed under the terms of the MIT License.

Remember to replace jgwill with your actual GitHub username and provide a usage example in the Usage section.

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

jgtutils-0.2.220.tar.gz (58.5 kB view details)

Uploaded Source

Built Distribution

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

jgtutils-0.2.220-py3-none-any.whl (68.7 kB view details)

Uploaded Python 3

File details

Details for the file jgtutils-0.2.220.tar.gz.

File metadata

  • Download URL: jgtutils-0.2.220.tar.gz
  • Upload date:
  • Size: 58.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.16

File hashes

Hashes for jgtutils-0.2.220.tar.gz
Algorithm Hash digest
SHA256 9a766706fdbf0a8faeef43cf1a7c78d4ce428c53004abcfc4dc52141140e4d35
MD5 0851d8e84a7d260c027ad127482e5d21
BLAKE2b-256 b7e93bf319c455b9756b51e17fcc32a015476180ec6524c3545e156f9f60cab5

See more details on using hashes here.

File details

Details for the file jgtutils-0.2.220-py3-none-any.whl.

File metadata

  • Download URL: jgtutils-0.2.220-py3-none-any.whl
  • Upload date:
  • Size: 68.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.16

File hashes

Hashes for jgtutils-0.2.220-py3-none-any.whl
Algorithm Hash digest
SHA256 a96ef0c6e0dbd4b82863efe8f5fc6e2a3ccb99a7132025f1ef6426bf72dc7d97
MD5 b65963eb00660328fc62f2a0d66a7923
BLAKE2b-256 b9492525e661900456587156ff5828d45e76952cfb6da6047c324c37d90d720f

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