dcrx-kv


Namedcrx-kv JSON
Version 0.1.3 PyPI version JSON
download
home_pagehttps://github.com/scorbettUM/dcrx-kv
SummaryA RESTful implementation of the DCRX Docker library.
upload_time2023-06-14 04:54:07
maintainer
docs_urlNone
authorSean Corbett
requires_python>=3.10
license
keywords pypi cicd python setup docker infra devops fastapi
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # dcrx-kv
[![PyPI version](https://img.shields.io/pypi/v/dcrx-kv?color=gre)](https://pypi.org/project/dcrx-kv/)
[![License](https://img.shields.io/github/license/scorbettUM/dcrx-kv)](https://github.com/scorbettUM/dcrx-kv/blob/main/LICENSE)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/scorbettUM/dcrx-kv/blob/main/CODE_OF_CONDUCT.md)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dcrx-kv)](https://pypi.org/project/dcrx-kv/)

DCRX-KV is a RESTful key/value service that utilizes a combination of an in-memory filesystem and permanent storage to facilitate easy upload and download of files. DCRX-KV permanent storage is accomplished via integrations with:

- AWS S3
- Azure Blob Storage
- Google Cloud Storage

and/or writing to disk.

DCRX-KV also includes basic JWT authorization and user management (no-RBAC), and is intended to be deployed as an internal-facing service. dcrx also provides OpenAPI documentation to make getting started intuitive, and features integrations with SQLite, Postgres, and MySQL for storing and managing users.


# Setup and Installation

DCRX-KV is available both as a Docker image and as a PyPi package. For local use, we recommend using PyPi, Python 3.10+, and a virtual environment. To install, run:

```bash
python -m venv ~/.dcrx && \
source ~/.dcrx/bin/activate && \
pip install dcrx-kv
```

To get the Docker image, run:

```
docker pull adalundhe/dcrx-kv:latest
```


# Getting Started

TBA

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/scorbettUM/dcrx-kv",
    "name": "dcrx-kv",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": "",
    "keywords": "pypi,cicd,python,setup,docker,infra,devops,fastapi",
    "author": "Sean Corbett",
    "author_email": "sean.corbett@umontana.edu",
    "download_url": "https://files.pythonhosted.org/packages/ab/b1/001442d7ea2e3e1c9c0d254c06d617c05e4bae14148c16e42140b6e23df1/dcrx-kv-0.1.3.tar.gz",
    "platform": null,
    "description": "# dcrx-kv\n[![PyPI version](https://img.shields.io/pypi/v/dcrx-kv?color=gre)](https://pypi.org/project/dcrx-kv/)\n[![License](https://img.shields.io/github/license/scorbettUM/dcrx-kv)](https://github.com/scorbettUM/dcrx-kv/blob/main/LICENSE)\n[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/scorbettUM/dcrx-kv/blob/main/CODE_OF_CONDUCT.md)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/dcrx-kv)](https://pypi.org/project/dcrx-kv/)\n\nDCRX-KV is a RESTful key/value service that utilizes a combination of an in-memory filesystem and permanent storage to facilitate easy upload and download of files. DCRX-KV permanent storage is accomplished via integrations with:\n\n- AWS S3\n- Azure Blob Storage\n- Google Cloud Storage\n\nand/or writing to disk.\n\nDCRX-KV also includes basic JWT authorization and user management (no-RBAC), and is intended to be deployed as an internal-facing service. dcrx also provides OpenAPI documentation to make getting started intuitive, and features integrations with SQLite, Postgres, and MySQL for storing and managing users.\n\n\n# Setup and Installation\n\nDCRX-KV is available both as a Docker image and as a PyPi package. For local use, we recommend using PyPi, Python 3.10+, and a virtual environment. To install, run:\n\n```bash\npython -m venv ~/.dcrx && \\\nsource ~/.dcrx/bin/activate && \\\npip install dcrx-kv\n```\n\nTo get the Docker image, run:\n\n```\ndocker pull adalundhe/dcrx-kv:latest\n```\n\n\n# Getting Started\n\nTBA\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A RESTful implementation of the DCRX Docker library.",
    "version": "0.1.3",
    "project_urls": {
        "Homepage": "https://github.com/scorbettUM/dcrx-kv"
    },
    "split_keywords": [
        "pypi",
        "cicd",
        "python",
        "setup",
        "docker",
        "infra",
        "devops",
        "fastapi"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b053348f8c7c708f06ec5c09f1840c301585ef5385dcb034f83cbb72495e75d2",
                "md5": "7c20352568c2af70e2a07245ccebcfa2",
                "sha256": "5739fbd779fcb15e76dba3c056c8bef6b1468899c0ff60a292230258feb9d529"
            },
            "downloads": -1,
            "filename": "dcrx_kv-0.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7c20352568c2af70e2a07245ccebcfa2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 45614,
            "upload_time": "2023-06-14T04:54:05",
            "upload_time_iso_8601": "2023-06-14T04:54:05.780010Z",
            "url": "https://files.pythonhosted.org/packages/b0/53/348f8c7c708f06ec5c09f1840c301585ef5385dcb034f83cbb72495e75d2/dcrx_kv-0.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "abb1001442d7ea2e3e1c9c0d254c06d617c05e4bae14148c16e42140b6e23df1",
                "md5": "b4f52050ecf25713e5c7e169183bb164",
                "sha256": "51f20640dd17e17f5b66e39870d7bbd2cf7b73b695ed80e63772a06970534d58"
            },
            "downloads": -1,
            "filename": "dcrx-kv-0.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "b4f52050ecf25713e5c7e169183bb164",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 26626,
            "upload_time": "2023-06-14T04:54:07",
            "upload_time_iso_8601": "2023-06-14T04:54:07.415670Z",
            "url": "https://files.pythonhosted.org/packages/ab/b1/001442d7ea2e3e1c9c0d254c06d617c05e4bae14148c16e42140b6e23df1/dcrx-kv-0.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-14 04:54:07",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "scorbettUM",
    "github_project": "dcrx-kv",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [],
    "lcname": "dcrx-kv"
}
        
Elapsed time: 0.09784s