artifact-hub


Nameartifact-hub JSON
Version 0.0.3 PyPI version JSON
download
home_page
SummaryUse object storage as a self hosted hub
upload_time2023-03-11 22:54:27
maintainer
docs_urlNone
author
requires_python>=3.7
licenseMIT License Copyright (c) 2023 Robots Limited Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords artifacts hub storage
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # artifact-hub

![main workflow](https://github.com/robotstech/artifact-hub/actions/workflows/test.yml/badge.svg) <br>

Manage artifacts using object storage. Manage all kinds of artifacts E.g. models, json files, sqlite dbs and track their
versions and history using any object store as a backend. This project facilitates self-hosted hub without a lot of
management overhead.

Currently supported object stores include:

- S3

## Installation

```shell
pip install artifact-hub
```

## Usage

1. Create a sample file `sample.txt`
    ```text
    This is a sample file 
    with multiline content
    ```

2. Initialize the hub instance for a specific object/project
   ```python
   from artifact_hub import s3_hub
   
   hub = s3_hub("bucket", "folder", "object_id")
   hub.push("sample.txt", "first push", "description of first push")
   ```

## Limitations

1. Concurrent push and pulls from multiple parties at the same time can not be handled. because of the linear nature of
   the history the last push will overwrite the previous one.
   ```text
   Actor A and B tries to push concurrently
   Actor A and B pull latest version 10
   Actor A complete push version 11 early
   Actor B completes push version 11 late and overwrite Actor A's push. This may happen when Actor B is pushing a much larger change than A's
   ```
            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "artifact-hub",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "iamr0b0tx <tech@robotslimited.com>",
    "keywords": "artifacts,hub,storage",
    "author": "",
    "author_email": "iamr0b0tx <tech@robotslimited.com>",
    "download_url": "https://files.pythonhosted.org/packages/67/01/bb8efae1b17c5154752e62e270a653e39e1389510c53eee7a0c855480d17/artifact_hub-0.0.3.tar.gz",
    "platform": null,
    "description": "# artifact-hub\n\n![main workflow](https://github.com/robotstech/artifact-hub/actions/workflows/test.yml/badge.svg) <br>\n\nManage artifacts using object storage. Manage all kinds of artifacts E.g. models, json files, sqlite dbs and track their\nversions and history using any object store as a backend. This project facilitates self-hosted hub without a lot of\nmanagement overhead.\n\nCurrently supported object stores include:\n\n- S3\n\n## Installation\n\n```shell\npip install artifact-hub\n```\n\n## Usage\n\n1. Create a sample file `sample.txt`\n    ```text\n    This is a sample file \n    with multiline content\n    ```\n\n2. Initialize the hub instance for a specific object/project\n   ```python\n   from artifact_hub import s3_hub\n   \n   hub = s3_hub(\"bucket\", \"folder\", \"object_id\")\n   hub.push(\"sample.txt\", \"first push\", \"description of first push\")\n   ```\n\n## Limitations\n\n1. Concurrent push and pulls from multiple parties at the same time can not be handled. because of the linear nature of\n   the history the last push will overwrite the previous one.\n   ```text\n   Actor A and B tries to push concurrently\n   Actor A and B pull latest version 10\n   Actor A complete push version 11 early\n   Actor B completes push version 11 late and overwrite Actor A's push. This may happen when Actor B is pushing a much larger change than A's\n   ```",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2023 Robots Limited  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
    "summary": "Use object storage as a self hosted hub",
    "version": "0.0.3",
    "split_keywords": [
        "artifacts",
        "hub",
        "storage"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e600879febf98101149fdf770f98722f033350b5ead3a6d8b7e689208f0292a7",
                "md5": "cfacf63637274eb275a065b9cb4b0381",
                "sha256": "588de5d056bc45a169bae3962273841e76d65536901cf392e445c984d4a918f2"
            },
            "downloads": -1,
            "filename": "artifact_hub-0.0.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "cfacf63637274eb275a065b9cb4b0381",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 7179,
            "upload_time": "2023-03-11T22:54:26",
            "upload_time_iso_8601": "2023-03-11T22:54:26.120493Z",
            "url": "https://files.pythonhosted.org/packages/e6/00/879febf98101149fdf770f98722f033350b5ead3a6d8b7e689208f0292a7/artifact_hub-0.0.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6701bb8efae1b17c5154752e62e270a653e39e1389510c53eee7a0c855480d17",
                "md5": "9d6eb03aac644af24ab1a436d6c03e96",
                "sha256": "cac3b2379868b2beaac5866da78aebcb61ebf79b12f4febde75c4fd03db1996e"
            },
            "downloads": -1,
            "filename": "artifact_hub-0.0.3.tar.gz",
            "has_sig": false,
            "md5_digest": "9d6eb03aac644af24ab1a436d6c03e96",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 9383,
            "upload_time": "2023-03-11T22:54:27",
            "upload_time_iso_8601": "2023-03-11T22:54:27.804852Z",
            "url": "https://files.pythonhosted.org/packages/67/01/bb8efae1b17c5154752e62e270a653e39e1389510c53eee7a0c855480d17/artifact_hub-0.0.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-03-11 22:54:27",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "artifact-hub"
}
        
Elapsed time: 0.05520s