Skip to main content

A database writed entirely on python, Tinrux is not redis

Project description

Tinrux Database

PyPI - Version PyPI - Python Version License: GPLv3


A lightweight Redis-inspired database written in pure Python, designed for small-scale applications needing simple persistence.

✨ Features

  • Redis-like commands: SET, GET, DEL, EXPIRE, etc.
  • Auto-persistence: Saves data to JSON for more read (tdb.json).
  • Server/Client mode: Runs as a standalone service.
  • Zero dependencies: Pure Python (≥ 3.6).
  • Autosaving system: Saves automatically the database (by default every 15 minutes).
  • Cookie's management system: Has a cookie's management system for logins and more!

🚀 Installation

pip install tinrux

🛠️ Basic Usage

Make a new db:

tinrux server localhost 5000 new

Start a saved server:

tinrux server localhost 5000

Interactive client:

tinrux client localhost 5000

Python example:

(localhost:5000)>>> SET greeting "Hello Tinrux"
OK
(localhost:5000)>>> GET greeting
Hello Tinrux

📝 Why JSON?

Tinrux uses JSON for persistance due to several key advantages:

  • Human-readable format: JSON files are easy to inspect and modify manually, making debugging and testing more straightforward.
  • Language interoperability: JSON is widely supported across programming languages, allowing easy data export or import into other systems.
  • Lightweight and structured: Perfect for small-scale applications where full databse engines are overkill, but a clear and structured format is still needed.
  • Built-in support in Python: Using Python's standard json module eliminates the need for external dependencies and ensures compatibility.

This choice aligns with Tinrux's philosophy of simplicity, transparency and minimalism.

📚 Available Commands

Command Description Example
SET Store a value SET key value
GET Retrieve a value GET key
DEL Delete a key DEL key
EXPIRE Set key expiration (sec) EXPIRE key 10
SAVE Manual data persistence SAVE
PUSH PUSH NEW DATA PUSH key 5
POP POP A VALUE POP key
STACK initializes a entry as a stack POP key
HELP Help command HELP

📦 Project Structure

tinrux/
├── src/
│    └── tinrux/
│         ├── tinruxClient.py  # Connection handler
│         ├── tinruxServer.py  # Core database engine
│         ├── __about__.py # version
│         ├── __init__.py # packet
│         └── cli.py           # Command-line interface

📄 License

tinrux is distributed under the terms of the GPLv3 license.

GNU General Public License v3.0 - See LICENSE.txt.

Contributors

Make pull request to be here!

Contributing

Contributing

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

tinrux-0.1.3.tar.gz (30.3 kB view details)

Uploaded Source

Built Distribution

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

tinrux-0.1.3-py3-none-any.whl (33.6 kB view details)

Uploaded Python 3

File details

Details for the file tinrux-0.1.3.tar.gz.

File metadata

  • Download URL: tinrux-0.1.3.tar.gz
  • Upload date:
  • Size: 30.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for tinrux-0.1.3.tar.gz
Algorithm Hash digest
SHA256 cd7112b857a012c477bad440d49d14c52fd580689ddc69e481c8414c7279b776
MD5 4855fe2030e866cda0a9ccb49f4f4b7e
BLAKE2b-256 2a6afc74cef57820e77fd4f0a966f4f3ece2aa18430ef4be770c6527114238d5

See more details on using hashes here.

File details

Details for the file tinrux-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: tinrux-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 33.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.2

File hashes

Hashes for tinrux-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 a4fc6724e131d4a04fb59a3dfe58581f9d9e7f2fcc96cc06f0a540be24ddd483
MD5 59297d3eff3365ce1dd91ea41ca90b45
BLAKE2b-256 f9bc4757ce7520738cfef84e5380305292ee8a000e22947c6ff0c46f050433d2

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