{"id":27110850,"url":"https://github.com/guille-ux/tinrux","last_synced_at":"2025-04-12T15:53:31.489Z","repository":{"id":286358401,"uuid":"961181868","full_name":"Guille-ux/tinrux","owner":"Guille-ux","description":"Tinrux is not redis","archived":false,"fork":false,"pushed_at":"2025-04-06T11:59:52.000Z","size":413,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-11T15:06:01.614Z","etag":null,"topics":["database","hatch","open-source","opensource","packet","pip","pip3","pypi","python","python3","redis","tinrux"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Guille-ux.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2025-04-05T23:46:12.000Z","updated_at":"2025-04-06T11:59:55.000Z","dependencies_parsed_at":"2025-04-09T21:52:56.185Z","dependency_job_id":null,"html_url":"https://github.com/Guille-ux/tinrux","commit_stats":null,"previous_names":["guille-ux/tinrux"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Guille-ux%2Ftinrux","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Guille-ux%2Ftinrux/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Guille-ux%2Ftinrux/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Guille-ux%2Ftinrux/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Guille-ux","download_url":"https://codeload.github.com/Guille-ux/tinrux/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248592210,"owners_count":21130206,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["database","hatch","open-source","opensource","packet","pip","pip3","pypi","python","python3","redis","tinrux"],"created_at":"2025-04-07T00:40:56.793Z","updated_at":"2025-04-12T15:53:31.483Z","avatar_url":"https://github.com/Guille-ux.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tinrux Database\n\n[![PyPI - Version](https://img.shields.io/pypi/v/tinrux.svg)](https://pypi.org/project/tinrux)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/tinrux.svg)](https://pypi.org/project/tinrux)\n[![License: GPLv3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)\n\n-----------------\n\nA lightweight Redis-inspired database written in pure Python, designed for small-scale applications needing simple persistence.\n\n## ✨ Features\n\n- **Redis-like commands**: `SET`, `GET`, `DEL`, `EXPIRE`, etc.\n- **Auto-persistence**: Saves data to JSON for more read (`tdb.json`).\n- **Server/Client mode**: Runs as a standalone service.\n- **Zero dependencies**: Pure Python (≥ 3.6).\n- **Autosaving system**: Saves automatically the database (by default every 15 minutes).\n\n## 🚀 Installation\n\n```bash\npip install tinrux\n```\n\n## 🛠️ Basic Usage\n\nMake a new db:\n\n```bash\ntinrux server localhost 5000 new\n```\n\nStart a saved server:\n\n```bash\ntinrux server localhost 5000\n```\n\nInteractive client:\n\n```bash\ntinrux client localhost 5000\n```\n\nPython example:\n\n```python\n(localhost:5000)\u003e\u003e\u003e SET greeting \"Hello Tinrux\"\nOK\n(localhost:5000)\u003e\u003e\u003e GET greeting\nHello Tinrux\n```\n\n## 📝 Why JSON?\n\nTinrux uses JSON for persistance due to several key advantages:\n- **Human-readable format**: JSON files are easy to inspect and modify manually, making debugging and testing more straightforward.\n- **Language interoperability**: JSON is widely supported across programming languages, allowing easy data export or import into other systems.\n- **Lightweight and structured**: Perfect for small-scale applications where full databse engines are overkill, but a clear and structured format is still needed.\n- **Built-in support in Python**: Using Python's standard `json` module eliminates the need for external dependencies and ensures compatibility.\n\nThis choice aligns with Tinrux's philosophy of simplicity, transparency and minimalism.\n\n## 📚 Available Commands\n\n| Command | Description              | Example       |\n| ------- | ------------------------ | ------------- |\n| SET     | Store a value            | SET key value |\n| GET     | Retrieve a value         | GET key       |\n| DEL     | Delete a key             | DEL key       |\n| EXPIRE  | Set key expiration (sec) | EXPIRE key 10 |\n| SAVE    | Manual data persistence  | SAVE          |\n| HELP    | Help command             | HELP          |\n\n## 📦 Project Structure\n\n```\ntinrux/\n├── src/\n│    └── tinrux/\n│         ├── tinruxClient.py  # Connection handler\n│         ├── tinruxServer.py  # Core database engine\n│         ├── __about__.py # version\n│         ├── __init__.py # packet\n│         └── cli.py           # Command-line interface\n```\n\n## 📄 License\n\n`tinrux` is distributed under the terms of the [GPLv3](https://spdx.org/licenses/GPL-3.0-or-later.html) license.\n\nGNU General Public License v3.0 - See LICENSE.txt.\n\n## Contributors\nMake pull request to be here!\n\n\n## Contributing\n\n[Contributing](CONTRIBUTING.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguille-ux%2Ftinrux","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fguille-ux%2Ftinrux","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguille-ux%2Ftinrux/lists"}