aimrecords


Nameaimrecords JSON
Version 0.0.7 PyPI version JSON
download
home_page
SummaryA record-oriented data format which utilizes Protocol Buffers
upload_time2020-11-09 13:29:29
maintainer
docs_urlNone
author
requires_python>=3.5.0
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            
# AimRecords - Record-oriented data storage

![GitHub Top Language](https://img.shields.io/github/languages/top/aimhubio/aimrecords)
[![PyPI Package](https://img.shields.io/pypi/v/aimrecords?color=yellow)](https://pypi.org/project/aimrecords/)
[![License](https://img.shields.io/badge/License-Apache%202.0-orange.svg)](https://opensource.org/licenses/Apache-2.0)


Library to effectively store the tracked experiment logs.

See the documentation [here](docs/README.md).

## Getting Started

These instructions will get you a copy of the project up and running on your 
local machine for development and testing purposes.

### Requirements

* Python 3

We suggest to use [virtual
environment](https://packaging.python.org/tutorials/installing-packages/#creating-virtual-environments) for managing local dependencies.

To start development first install all dependencies:

```bash
pip install -r requirements.txt
```

### Project Structure

```
├── aimrecords  <-----------  main project code
│   ├── artifact_storage  <-  manage storage of artifacts
│   └── record_storage  <---  manage records storage of a single artifact
├── docs  <-----------------  data format documentation
├── examples  <-------------  example usages of aimrecords
└── tests
```

## Running the tests

Run tests via command `pytest` in the root folder.

### Code Style
We follow [pep8](https://www.python.org/dev/peps/pep-0008/) style guide 
for python code.

## Contributing

Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our 
code of conduct, and the process for submitting pull requests to us.



            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "aimrecords",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.5.0",
    "maintainer_email": "",
    "keywords": "",
    "author": "",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/c9/10/21182ef96acbd9a5ca4008556ba8590cbc1af833eccbf59d53308fa6d928/aimrecords-0.0.7.tar.gz",
    "platform": "",
    "description": "\n# AimRecords - Record-oriented data storage\n\n![GitHub Top Language](https://img.shields.io/github/languages/top/aimhubio/aimrecords)\n[![PyPI Package](https://img.shields.io/pypi/v/aimrecords?color=yellow)](https://pypi.org/project/aimrecords/)\n[![License](https://img.shields.io/badge/License-Apache%202.0-orange.svg)](https://opensource.org/licenses/Apache-2.0)\n\n\nLibrary to effectively store the tracked experiment logs.\n\nSee the documentation [here](docs/README.md).\n\n## Getting Started\n\nThese instructions will get you a copy of the project up and running on your \nlocal machine for development and testing purposes.\n\n### Requirements\n\n* Python 3\n\nWe suggest to use [virtual\nenvironment](https://packaging.python.org/tutorials/installing-packages/#creating-virtual-environments) for managing local dependencies.\n\nTo start development first install all dependencies:\n\n```bash\npip install -r requirements.txt\n```\n\n### Project Structure\n\n```\n\u251c\u2500\u2500 aimrecords  <-----------  main project code\n\u2502\u00a0\u00a0 \u251c\u2500\u2500 artifact_storage  <-  manage storage of artifacts\n\u2502\u00a0\u00a0 \u2514\u2500\u2500 record_storage  <---  manage records storage of a single artifact\n\u251c\u2500\u2500 docs  <-----------------  data format documentation\n\u251c\u2500\u2500 examples  <-------------  example usages of aimrecords\n\u2514\u2500\u2500 tests\n```\n\n## Running the tests\n\nRun tests via command `pytest` in the root folder.\n\n### Code Style\nWe follow [pep8](https://www.python.org/dev/peps/pep-0008/) style guide \nfor python code.\n\n## Contributing\n\nPlease read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our \ncode of conduct, and the process for submitting pull requests to us.\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A record-oriented data format which utilizes Protocol Buffers",
    "version": "0.0.7",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5313207ebb5b2315640a68378c31cb31cfe1182373d11a813bd52219c83700a7",
                "md5": "df4000528d6aceed912ec4103f24d90a",
                "sha256": "b9276890891c5fd68f817e20fc5d466a80c01e22fa468eaa979331448a75d601"
            },
            "downloads": -1,
            "filename": "aimrecords-0.0.7-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "df4000528d6aceed912ec4103f24d90a",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.5.0",
            "size": 28657,
            "upload_time": "2020-11-09T13:29:26",
            "upload_time_iso_8601": "2020-11-09T13:29:26.015050Z",
            "url": "https://files.pythonhosted.org/packages/53/13/207ebb5b2315640a68378c31cb31cfe1182373d11a813bd52219c83700a7/aimrecords-0.0.7-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c91021182ef96acbd9a5ca4008556ba8590cbc1af833eccbf59d53308fa6d928",
                "md5": "559e18eebf48432f1c1de9a75723b8b7",
                "sha256": "9b562fa5b5109b4b3dd4f83be0061cadbac63fa8031f281b8b5c8ae29967072f"
            },
            "downloads": -1,
            "filename": "aimrecords-0.0.7.tar.gz",
            "has_sig": false,
            "md5_digest": "559e18eebf48432f1c1de9a75723b8b7",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.5.0",
            "size": 12667,
            "upload_time": "2020-11-09T13:29:29",
            "upload_time_iso_8601": "2020-11-09T13:29:29.071067Z",
            "url": "https://files.pythonhosted.org/packages/c9/10/21182ef96acbd9a5ca4008556ba8590cbc1af833eccbf59d53308fa6d928/aimrecords-0.0.7.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-11-09 13:29:29",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "aimrecords"
}
        
Elapsed time: 0.77689s