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
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.0.11.tar.gz (28.2 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.0.11-py3-none-any.whl (30.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for tinrux-0.0.11.tar.gz
Algorithm Hash digest
SHA256 891a1de8103167efa597835c03731fc34aba4a4b52814e93802607385e2f6751
MD5 4c9f07d865c83cf1cd5d7a9c1ef91cca
BLAKE2b-256 ca2c6ad462b0ce3cbd888fcecb9af003b90c833cc7e90980adc6bb7a0d3781fe

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for tinrux-0.0.11-py3-none-any.whl
Algorithm Hash digest
SHA256 1693df349ac3b4d73eee3f007fa5d15f5f8220ba1d318aed486f875ef2ef29c9
MD5 23085e41dbad1544a06c56cdcec7dd8c
BLAKE2b-256 f2cbeb49ac89da4e90cd35b98ce3e6513637a1700149bfc399cf982e960ce1cd

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