contaxy

Name	contaxy JSON
Version	0.0.23 JSON
	download
home_page	https://github.com/ml-tooling/contaxy
Summary	Python package template.
upload_time	2023-01-20 09:55:39
maintainer
docs_url	None
author	ML Tooling Team
requires_python	>=3.8
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Python Library Template

_WIP: Document python library._

## Requirements

* Python 3.6+

## Installation

Install via pip:

```bash
pip install --upgrade -e path/to/lib
```

## Usage

After installation, the package can be imported:

```python
import template_package
```

## Development

This library uses [black](https://github.com/psf/black) for auto-formatting, [isort](https://github.com/PyCQA/isort) for import sorting, [flake8](https://github.com/PyCQA/flake8) for linting, [mypy](https://github.com/python/mypy) for type checking, and [pydocstyle](https://github.com/PyCQA/pydocstyle) for docstring style checks. All code is written compatible with Python 3.6+, with type hints wherever possible.

## Testing

* DeploymentManager:
  * By default, just the DockerDeploymentManager is executed. To execute also the Kubernetes-related tests, a Kubernetes cluster has to be available from where the code is executed. On your local Mac, you can simply start one by executing `kind create cluster`. Then execute the tests by setting the environment variable `KUBE_AVAILABLE=true` (in VS Code, you can for example set the env variable in the `launch.json` or append it in front of the pytest command, e.g. `KUBE_AVAILABLE=true pytest...`)



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/ml-tooling/contaxy",
    "name": "contaxy",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "ML Tooling Team",
    "author_email": "team@mltooling.org",
    "download_url": "https://files.pythonhosted.org/packages/8f/7f/9996bbdaac22e93121a4659dd89054efe8606b3034155589d0afc6062b8b/contaxy-0.0.23.tar.gz",
    "platform": null,
    "description": "# Python Library Template\n\n_WIP: Document python library._\n\n## Requirements\n\n* Python 3.6+\n\n## Installation\n\nInstall via pip:\n\n```bash\npip install --upgrade -e path/to/lib\n```\n\n## Usage\n\nAfter installation, the package can be imported:\n\n```python\nimport template_package\n```\n\n## Development\n\nThis library uses [black](https://github.com/psf/black) for auto-formatting, [isort](https://github.com/PyCQA/isort) for import sorting, [flake8](https://github.com/PyCQA/flake8) for linting, [mypy](https://github.com/python/mypy) for type checking, and [pydocstyle](https://github.com/PyCQA/pydocstyle) for docstring style checks. All code is written compatible with Python 3.6+, with type hints wherever possible.\n\n## Testing\n\n* DeploymentManager:\n  * By default, just the DockerDeploymentManager is executed. To execute also the Kubernetes-related tests, a Kubernetes cluster has to be available from where the code is executed. On your local Mac, you can simply start one by executing `kind create cluster`. Then execute the tests by setting the environment variable `KUBE_AVAILABLE=true` (in VS Code, you can for example set the env variable in the `launch.json` or append it in front of the pytest command, e.g. `KUBE_AVAILABLE=true pytest...`)\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Python package template.",
    "version": "0.0.23",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c123a83b54ef5b3578c301dce39f4b2ca41b78d1c3eaf22e44d9ebf7926fbb8f",
                "md5": "4263075b67a8416f26cf1e4a92fc13a3",
                "sha256": "829dbe50c710139c1c49ea0c89851940d219362de9d46e12359adc160602fe95"
            },
            "downloads": -1,
            "filename": "contaxy-0.0.23-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4263075b67a8416f26cf1e4a92fc13a3",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 159891,
            "upload_time": "2023-01-20T09:55:38",
            "upload_time_iso_8601": "2023-01-20T09:55:38.566452Z",
            "url": "https://files.pythonhosted.org/packages/c1/23/a83b54ef5b3578c301dce39f4b2ca41b78d1c3eaf22e44d9ebf7926fbb8f/contaxy-0.0.23-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "8f7f9996bbdaac22e93121a4659dd89054efe8606b3034155589d0afc6062b8b",
                "md5": "0718260ecc91ebbbfe4a70ffb3acdaaa",
                "sha256": "eaf6d4006a9847645bef5244538235f9acf05cd160e9e0abaef50f7f7bdd1724"
            },
            "downloads": -1,
            "filename": "contaxy-0.0.23.tar.gz",
            "has_sig": false,
            "md5_digest": "0718260ecc91ebbbfe4a70ffb3acdaaa",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 123297,
            "upload_time": "2023-01-20T09:55:39",
            "upload_time_iso_8601": "2023-01-20T09:55:39.928633Z",
            "url": "https://files.pythonhosted.org/packages/8f/7f/9996bbdaac22e93121a4659dd89054efe8606b3034155589d0afc6062b8b/contaxy-0.0.23.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-20 09:55:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": "ml-tooling",
    "github_project": "contaxy",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "contaxy"
}