{"id":17551021,"url":"https://github.com/brianlusina/kvault","last_synced_at":"2025-04-24T01:12:40.701Z","repository":{"id":58801854,"uuid":"533817111","full_name":"BrianLusina/kvault","owner":"BrianLusina","description":"Simple Miniature Key-Value Database","archived":false,"fork":false,"pushed_at":"2025-04-23T06:57:59.000Z","size":999,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-23T07:34:37.073Z","etag":null,"topics":["database","hacktoberfest","key-value-store","python"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BrianLusina.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-09-07T15:04:41.000Z","updated_at":"2025-04-23T06:57:56.000Z","dependencies_parsed_at":"2023-11-15T07:30:43.523Z","dependency_job_id":"485b1398-44be-4b46-b535-7c1be6002202","html_url":"https://github.com/BrianLusina/kvault","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BrianLusina%2Fkvault","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BrianLusina%2Fkvault/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BrianLusina%2Fkvault/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BrianLusina%2Fkvault/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BrianLusina","download_url":"https://codeload.github.com/BrianLusina/kvault/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250394881,"owners_count":21423362,"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","hacktoberfest","key-value-store","python"],"created_at":"2024-10-21T04:44:39.345Z","updated_at":"2025-04-24T01:12:40.684Z","avatar_url":"https://github.com/BrianLusina.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# kvault\n\n[![License](https://img.shields.io/github/license/brianlusina/kvault)](https://github.com/brianlusina/kvault/blob/main/LICENSE)\n[![Tests](https://github.com/BrianLusina/kvault/actions/workflows/tests.yaml/badge.svg)](https://github.com/BrianLusina/kvault/actions/workflows/tests.yaml)\n[![Lint](https://github.com/BrianLusina/kvault/actions/workflows/lint.yml/badge.svg)](https://github.com/BrianLusina/kvault/actions/workflows/lint.yml)\n[![Docker](https://github.com/BrianLusina/kvault/actions/workflows/docker.yaml/badge.svg)](https://github.com/BrianLusina/kvault/actions/workflows/docker.yaml)\n[![Version](https://img.shields.io/github/v/release/brianlusina/kvault?color=%235351FB\u0026label=version)](https://github.com/brianlusina/kvault/releases)\n[![Codacy Badge](https://app.codacy.com/project/badge/Grade/fbb1708155284277be89e61c867d94ff)](https://app.codacy.com/gh/BrianLusina/kvault/dashboard?utm_source=gh\u0026utm_medium=referral\u0026utm_content=\u0026utm_campaign=Badge_grade)\n\n`kvault` is a simple Miniature Key-Value Datastore in Python with a [Redis](https://redis.io)-like interface.\n\n## Requirements\n\n1. [Python 3.10+](https://www.python.org/downloads/)\n\n   Python is the programming language of choice for this project, therefore, will be required to be available in\n   the system. One can download and setup Python in their local development environment following the steps provided in\n   the link.\n\n2. [Poetry](https://python-poetry.org/)\n\n   Poetry is the dependency manager \u0026 packaging tool used for this project and can be installed following the setup\n   provided in the link as well.\n\n3. [virtualenv](https://virtualenv.pypa.io/)\n\n   Used to create virtual environments for installing \u0026 setting up Python dependencies.\n\n## Setup\n\nRunning locally, will require a [virtualenv](https://virtualenv.pypa.io/) setup and that can be done by following the\ninstructions:\n\n```shell\nvirtualenv .venv\n```\n\n\u003e This will create a virtual environment in the current root directory of the project.\n\nNext, install the required dependencies:\n\n```shell\npoetry install\n```\n\n\u003e This installs the dependencies for the project.\n\n## Running\n\nby default, the `kvault` server runs on localhost:31337.\n\nThe following options are supported:\n\n```plain\nUsage: kvault.py [options]\n\nOptions:\n  -h, --help            show this help message and exit\n  -d, --debug           Log debug messages.\n  -e, --errors          Log error messages only.\n  -t, --use-threads     Use threads instead of gevent.\n  -H HOST, --host=HOST  Host to listen on.\n  -m MAX_CLIENTS, --max-clients=MAX_CLIENTS\n                        Maximum number of clients.\n  -p PORT, --port=PORT  Port to listen on.\n  -l LOG_FILE, --log-file=LOG_FILE\n                        Log file.\n  -x EXTENSIONS, --extension=EXTENSIONS\n                        Import path for Python extension module(s).\n```\n\nNote that the above output can be obtained from the below command:\n\n```shell\npython cli.py -h\n```\n\nTo run with debug logging on port 31339, for example:\n\n``` shell\npython kvault.py -d -p 31339\n``` \n\nThis will result in an output like below:\n\n```plain\n  .--.\n /( @ \u003e    ,-.  KVault 127.0.0.1:31339\n/ ' .'--._/  /\n:   ,    , .'\n'. (___.'_/\n ((-((-''\n\n```\n\n\u003e This indicates that the server is running and awaiting client connections\n\nClient setup should be simple, in another terminal, open a new Python console to interact with the kvault server:\n\n```python\nfrom client import Client\n\nclient = Client()\nclient.set('key', {'name': 'Charlie', 'pets': ['mickey', 'huey']})\n\nprint(client.get('key'))  # {'name': 'Charlie', 'pets': ['mickey', 'huey']}\n```\n\n\u003e A sample of the expected interaction of a client and `kvault` server\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrianlusina%2Fkvault","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrianlusina%2Fkvault","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrianlusina%2Fkvault/lists"}