cinnaroll


Namecinnaroll JSON
Version 0.2.5 PyPI version JSON
download
home_pagehttps://github.com/carthago-cloud/cinnaroll-python-lib
SummaryConfiguring, Packaging and Sending Machine Learning Models to Deployment at cinnaroll.ai
upload_time2022-12-01 19:53:20
maintainer
docs_urlNone
authorVirtusLab
requires_python>=3.7, <4
licenseApache License 2.0
keywords machine-learning ml deployment
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # cinnaroll Python library

## PyCharm setup

Make sure the following bundled plugins are enabled:
* Docker
* Git
* Markdown
* Ini
* IntelliLang (for language injections, e.g. Markdown/shell scripts in YAML)
* Shell Script (also: agree to enable Shellcheck when asked)
* YAML

Install the following non-bundled plugins from Marketplace:
* [Requirements](https://plugins.jetbrains.com/plugin/10837-requirements/)


## (Optional) Git hook setup

Install [`shellcheck`](https://github.com/koalaman/shellcheck#installing) and [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).

Install npm packages:
```shell
npm install --global remark-cli remark-lint-no-dead-urls remark-validate-links
```

From the top-level folder of the repository, run the following command:
```shell
ln -s ../../ci/checks/run-all-checks.sh .git/hooks/pre-commit
```


## Run tests locally

To develop that project and run tests locally, it is needed to have Python installed with `tox`.

Use `tox -e venv` to setup virtual environment to work on that project in your favorite IDE.
Use `.tox/venv/bin/python` as a reference `python` interpreter in your IDE.

To run tests, execute `tox`.

It's also possible to execute tests graphically in PyCharm (right-clicking on the test file
or clicking the green triangle on the left of the test case name), which can be very useful when debugging a single test case.
To do so, make sure that the libraries from [requirements.testenv.txt](requirements.testenv.txt) are installed in the current venv.


## Versioning

This tool is [semantically versioned](https://semver.org) with respect to all of the following:

* Python version compatibility
* command-line interface (commands and their options)
* format of its specific files (currently just `~/.cinnaroll/credentials`)
* accepted environment variables


## Release TODO list

Note that we merge code to `main` and use git tags for releases.

To perform a release:

1. Tag the current `main` commit and push the tag:

```shell
git checkout main
git pull origin main
git tag v<VERSION>
git push origin v<VERSION>
```

1. Once the [CI](https://github.com/carthago-cloud/cinnaroll-python-lib/actions) completes,
   verify that the latest pack has been uploaded to [PyPI](https://pypi.org/project/cinnaroll).



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/carthago-cloud/cinnaroll-python-lib",
    "name": "cinnaroll",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7, <4",
    "maintainer_email": "",
    "keywords": "machine-learning,ml,deployment",
    "author": "VirtusLab",
    "author_email": "service@cinnaroll.ai",
    "download_url": "https://files.pythonhosted.org/packages/83/86/b0a35cca07debf1759725fa5f2973caa67b4fffcdf7f3777e7e79dc2a847/cinnaroll-0.2.5.tar.gz",
    "platform": null,
    "description": "# cinnaroll Python library\n\n## PyCharm setup\n\nMake sure the following bundled plugins are enabled:\n* Docker\n* Git\n* Markdown\n* Ini\n* IntelliLang (for language injections, e.g. Markdown/shell scripts in YAML)\n* Shell Script (also: agree to enable Shellcheck when asked)\n* YAML\n\nInstall the following non-bundled plugins from Marketplace:\n* [Requirements](https://plugins.jetbrains.com/plugin/10837-requirements/)\n\n\n## (Optional) Git hook setup\n\nInstall [`shellcheck`](https://github.com/koalaman/shellcheck#installing) and [`npm`](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm).\n\nInstall npm packages:\n```shell\nnpm install --global remark-cli remark-lint-no-dead-urls remark-validate-links\n```\n\nFrom the top-level folder of the repository, run the following command:\n```shell\nln -s ../../ci/checks/run-all-checks.sh .git/hooks/pre-commit\n```\n\n\n## Run tests locally\n\nTo develop that project and run tests locally, it is needed to have Python installed with `tox`.\n\nUse `tox -e venv` to setup virtual environment to work on that project in your favorite IDE.\nUse `.tox/venv/bin/python` as a reference `python` interpreter in your IDE.\n\nTo run tests, execute `tox`.\n\nIt's also possible to execute tests graphically in PyCharm (right-clicking on the test file\nor clicking the green triangle on the left of the test case name), which can be very useful when debugging a single test case.\nTo do so, make sure that the libraries from [requirements.testenv.txt](requirements.testenv.txt) are installed in the current venv.\n\n\n## Versioning\n\nThis tool is [semantically versioned](https://semver.org) with respect to all of the following:\n\n* Python version compatibility\n* command-line interface (commands and their options)\n* format of its specific files (currently just `~/.cinnaroll/credentials`)\n* accepted environment variables\n\n\n## Release TODO list\n\nNote that we merge code to `main` and use git tags for releases.\n\nTo perform a release:\n\n1. Tag the current `main` commit and push the tag:\n\n```shell\ngit checkout main\ngit pull origin main\ngit tag v<VERSION>\ngit push origin v<VERSION>\n```\n\n1. Once the [CI](https://github.com/carthago-cloud/cinnaroll-python-lib/actions) completes,\n   verify that the latest pack has been uploaded to [PyPI](https://pypi.org/project/cinnaroll).\n\n\n",
    "bugtrack_url": null,
    "license": "Apache License 2.0",
    "summary": "Configuring, Packaging and Sending Machine Learning Models to Deployment at cinnaroll.ai",
    "version": "0.2.5",
    "split_keywords": [
        "machine-learning",
        "ml",
        "deployment"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "4f7431b30603a4d17a46de6e3ed8ddf4",
                "sha256": "3e0155d3f1664614d897023dceb9aa0064c84172c5b8c0a5b396a05110775771"
            },
            "downloads": -1,
            "filename": "cinnaroll-0.2.5-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4f7431b30603a4d17a46de6e3ed8ddf4",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": ">=3.7, <4",
            "size": 42067,
            "upload_time": "2022-12-01T19:53:18",
            "upload_time_iso_8601": "2022-12-01T19:53:18.587470Z",
            "url": "https://files.pythonhosted.org/packages/dc/80/6fb273cc932bada3f64351c2657a5d9f6014090e93cb827145796a124ce9/cinnaroll-0.2.5-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "deacaa32001908426440cf0c02ebf564",
                "sha256": "0d07031db571b948f42a91f5510eee79b8f57a839347f66a5d3234e5ba90e183"
            },
            "downloads": -1,
            "filename": "cinnaroll-0.2.5.tar.gz",
            "has_sig": false,
            "md5_digest": "deacaa32001908426440cf0c02ebf564",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7, <4",
            "size": 5383458,
            "upload_time": "2022-12-01T19:53:20",
            "upload_time_iso_8601": "2022-12-01T19:53:20.542362Z",
            "url": "https://files.pythonhosted.org/packages/83/86/b0a35cca07debf1759725fa5f2973caa67b4fffcdf7f3777e7e79dc2a847/cinnaroll-0.2.5.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2022-12-01 19:53:20",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "carthago-cloud",
    "github_project": "cinnaroll-python-lib",
    "lcname": "cinnaroll"
}
        
Elapsed time: 0.02927s