Skip to main content

Minimal input, auto path toolkit (mobile-first, Colab+Drive)

Project description

usekit

usekit is a lightweight, mobile-first utility toolkit designed for Google Colab + Google Drive workflows.

It provides a consistent 3-axis interface for file I/O, navigation, and execution:

USE.[ACTION].[OBJECT].[LOCATION]
Example: u.rjb() -> use.read.json.base()

The goal is to reduce path friction and make operations easy to remember and fast to run in constrained environments (mobile + notebooks).


Status

Version: 0.1.1a1 (Alpha)

  • API may change
  • Focus: stable core axes (action/object/location) and short aliases
  • Core DATA/NAVI layers complete, EXEC layer in progress

Install

Standard install (PyPI)

pip install usekit

Development install (editable)

pip install -e .

Requirements:

  • Python 3.7+
  • PyYAML
  • python-dotenv

Quick Start (1 minute)

import usekit
from usekit import use, u, safe, s

print("usekit:", usekit.__version__)

# Read JSON
data = u.rjb("config.json")

# Write YAML
u.wys("settings.yaml", {"key": "value"})

# Safe operations (returns None on error)
data = s.rjb("config.json")

Example: import a function and run it

use.imp.pyp.base("test_args:multiply")
multiply(39, 30, 0.2)

Core Concept: 3 Axes

ACTION: read, write, update, delete, exists, path, find, list, import, exec

OBJECT: json, yaml, txt, md, csv, sql, pyp (expanding)

LOCATION: base, sub, now, tmp, dir, cus (and custom presets)

Short aliases available

  • u.rjb() = use.read.json.base()
  • u.wys() = use.write.yaml.sub()
  • u.fjb() = use.find.json.base()

Parameter aliases (4+ chars)

# Both work identically:
u.rjb(name="config", keydata="user/email", debug=True)
u.rjb(nm="config", kd="user/email", dbg=True)

Formats

usekit focuses on a small set of core formats with dedicated parsers.

Dedicated parsers:

  • json, yaml, csv, sql, ddl, pkl, pyp

Unified text parser:

  • txt, md (and other text-like formats)

Auto-detection:

  • Format detected from file extension when possible

Environment (.env)

usekit bundles usekit/.env.example for automatic environment initialization.

  • .env.example is a required template file (package contract)
  • .env is generated/managed per user environment

Semantic paths:

u.rjb("@base/config.json")     # Project-wide absolute path

Philosophy

"Code is not function, but memory"

usekit follows Memory-Oriented Software Architecture (MOSA):

  • Functions follow how humans remember operations
  • SmallBig: 80% simple, 20% complex
  • Mobile-first: optimized for constrained environments

Authors

Created by The Little Prince

In collaboration with:

  • Rose (ROP - Reader-Oriented Persona) - ChatGPT friend
  • Fox (FOP - Flow-Oriented Persona) - Claude friend

Notes

  • This project is optimized for mobile + Colab workflows
  • If something feels missing, it is likely out of scope for the current alpha
  • Feature requests and feedback welcome via GitHub Issues

License

See 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

usekit-0.1.1a0.tar.gz (4.3 kB view details)

Uploaded Source

Built Distribution

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

usekit-0.1.1a0-py3-none-any.whl (4.7 kB view details)

Uploaded Python 3

File details

Details for the file usekit-0.1.1a0.tar.gz.

File metadata

  • Download URL: usekit-0.1.1a0.tar.gz
  • Upload date:
  • Size: 4.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.12

File hashes

Hashes for usekit-0.1.1a0.tar.gz
Algorithm Hash digest
SHA256 0728fb2be232d3321ec447ceb611488e13e2e1879fada97bb997ee266dfe16e1
MD5 27c99a5e2bf03e12de0bed03238390c6
BLAKE2b-256 7cd7029e46167dcb7d215312be7fd403f40fb1dd80dd13bd887e0a3baa25547d

See more details on using hashes here.

File details

Details for the file usekit-0.1.1a0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for usekit-0.1.1a0-py3-none-any.whl
Algorithm Hash digest
SHA256 0f7017084504daac4d0c56d9427fa5c2c6da43120c7acdda8f0efd905c547d9a
MD5 0fd36b12e4c323bbd235ceb2451bb657
BLAKE2b-256 318617eb7f4bdb2bcb44292a4eea6e8a224f4fdbe6c8ed761c8f5b5b63fd8835

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