docs: remove multinut.stultus module section from README.md for clarity

This commit is contained in:
Dominik Krenn 2025-09-23 07:55:37 +02:00
parent b965f6e64a
commit be848b6416

214
README.md
View File

@ -117,217 +117,3 @@ Understood, mistress.
Here is the final `README.md` **section** dedicated to your chaotic masterpiece:
---
## `multinut.stultus`
A logic module that proudly makes every operation slower, dumber, and HTTPS-dependent.
Each logical comparison or boolean operation is turned into a full HTTPS request to `https://stultus.chipperfluff.at`, for no reason other than chaos and fluff.
### Features
* Logic-as-a-Service™ (LaaS)
* Every basic logic op (`==`, `<`, `>`, `and`, `or`, `not`) done via remote API
* Combo logic like `>=` and `<=` make **three separate HTTPS calls** each
* Full TLS overhead, network latency, and JSON parsing baked into every `if` statement
* Built-in server availability check
* Custom `StultusUnavailable` exception when your logic server goes *poof*
---
### Available Functions
| Function | Description | HTTP Requests |
| --------------------- | ------------------- | ------------- |
| `EQUALS(a, b)` | Returns `a == b` | 1 |
| `GREATER(a, b)` | Returns `a > b` | 1 |
| `LESSER(a, b)` | Returns `a < b` | 1 |
| `NOT(x)` | Returns `not x` | 1 |
| `AND(*args)` | Returns `all(args)` | 1 |
| `OR(*args)` | Returns `any(args)` | 1 |
| `GREATER_EQUAL(a, b)` | Returns `a >= b` | **3** 💀 |
| `LESSER_EQUAL(a, b)` | Returns `a <= b` | **3** 💀 |
---
### Example Usage
```python
from multinut.stultus import GREATER_EQUAL, EQUALS, ping, StultusUnavailable
if ping():
print("Stultus server is online.")
try:
if GREATER_EQUAL(5, 5):
print("Greater or equal confirmed. Using three HTTP requests.")
except StultusUnavailable as err:
print(f"🛑 Failed to logic: {err}")
```
---
### `StultusUnavailable`
Every function in `multinut.stultus` relies on a sacred remote endpoint:
`https://stultus.chipperfluff.at`
When the shrine is unreachable—due to squirrels sleeping, servers crashing, or fate itself rejecting logic—any function will raise:
```python
StultusUnavailable: [STULTUS] Failed logic call to 'operation': [reason]
```
This ensures you *see your failure* instead of trusting a broken silence.
Because when truth is outsourced, **you deserve to know when the transmission failed.**
---
### `ping()`
Use `ping()` to determine whether the squirrel logic shrine is currently active:
```python
from multinut.stultus import ping
if ping():
print("Squirrel logic shrine is listening.")
else:
print("The fluff has left the network.")
```
Returns `True` only when the `/ping` endpoint returns `{ "status": "ok" }`.
False means the fluff is silent. Prepare your backup shrine.
---
### Latin Class Hierarchy
This module replaces standard Python primitives with HTTP-wrapped equivalents.
They override operators (`==`, `>=`, `+`, `[]`, etc.) and route them through remote endpoints—ensuring **maximum latency, fragility, and squirrel-blessed absurdity**.
| Class | Latin Meaning | Description |
| -------------- | ------------------ | ----------------------------------------------- |
| `StultusMixin` | Mixin of the Fool | Injects HTTP logic into all descendants |
| `StultusInt` | Foolish Integer | Arithmetic and comparison via HTTP |
| `StultusFloat` | Foolish Float | Same as above, with floating shame |
| `StultusStr` | Foolish String | Equality, `.upper()`, `.invert()` all delegated |
| `StultusBool` | Foolish Truth | Truth is no longer local |
| `StultusList` | Foolish List | Push, pop, index via remote POST |
| `StultusDict` | Foolish Dictionary | Dictionary access through divine lookup |
Example:
```python
from multinut.stultus import StultusInt, StultusStr
a = StultusInt(5)
b = StultusInt(3)
if a >= b:
print("Confirmed by the logic gods.")
word = StultusStr("uwu")
print(word.invert()) # 'uwu' reversed, via HTTP
```
---
### Available Remote Functions
Every operation is offloaded via HTTPS.
#### Logic
```python
EQUALS(a, b)
GREATER(a, b)
LESSER(a, b)
GREATER_EQUAL(a, b) # makes 3 HTTPS requests
LESSER_EQUAL(a, b)
NOT(x)
AND(*args)
OR(*args)
```
#### Math
```python
ADD(a, b)
SUB(a, b)
MUL(a, b)
DIV(a, b) # division by zero = "division by fluff"
RANDINT(a, b) # has artificial delay
RANGE(n, shuffle=True) # shuffled server-side
```
#### List Operations
```python
LEN(list)
LIST_INDEX(list, index)
LIST_PUSH(list, item)
LIST_POP(list)
```
#### Dictionary Access
```python
DICT_GET(dict, key)
```
#### String Tools
```python
UPPER(str)
INVERT(str)
```
#### Truthiness
```python
TRUTH(x)
BOOLIFY(str) # wraps eval (yes, really)
```
#### Time & Crypto
```python
TIME() # epoch + ISO + fluff-certainty
HASH_PASSWORD(pw, algo) # e.g. sha256, sha1, md5 (pls no)
```
---
## Disclaimer
> **⚠️ WARNING:**
> This module is deliberately slow, unsafe, and ridiculous.
> It outsources core logic to a remote web server.
> Use it only for:
>
> * Chaos
> * Rituals
> * Art
> * Demos that make DevOps cry
> Never in production. Never with real data.
> Do not test this on anyone you love.
---
## Contributing to `multinut.stultus`
Pull requests are **gloriously welcome** if they contain any of the following:
* Inefficient use of the network
* Operators reimplemented in Latin
* Dumb ideas with great commitment
* Broken logic wrapped in elegant lies
* New subclasses like `StultusComplex`, `StultusPath`, or `StultusEnum`
Please **do not fix performance, security, or clarity**.
The project is working *as irrationally designed.*
> *Veritas non localis est.*
> *Truth is not local.*
---