# Groot is a simple and kind-hearted tree people who longs for peace and has strong vitality
## Installation
```
$ pip install -r requirements.txt
$ python setup.py install
```
## Development
This project includes a number of helpers in the `Makefile` to streamline common development tasks.
### Environment Setup
The following demonstrates setting up and working with a development environment:
```
### create a virtualenv for development
$ make venv
$ source .venv/bin/activate
### run groot cli application
$ groot --help
### run pytest / coverage
$ make test
```
### Releasing to PyPi
Before releasing to PyPi, you must configure your login credentials:
Version will be tagged a timestamp related to latest commit if you are in 'alpha' stage,
such as: `0.0.1.dev20230407013444`
**~/.pypirc**:
```
[distutils]
index-servers =
pypi
jfrog-cariad
[pypi]
repository = https://upload.pypi.org/legacy/
username = __token__
password = <the api token generated by youself in pypi>
[jfrog-cariad]
repository = https://jfrog-prod.maezia.com:443/artifactory/api/pypi/devops-pypi-internal-local/
username = <USERNAME>
password = <PASSWORD/API_TOKEN>
```
Then use the included helper function via the `Makefile`:
```
$ make dist
$ make dist-upload
```
## Deployments
### Docker
Included is a basic `Dockerfile` for building and distributing `groot`,
and can be built with the included `make` helper:
```
$ make docker
$ docker run -it groot --help
```
Raw data
{
"_id": null,
"home_page": "https://gitlab-rd0.maezia.com/devopscm/groot",
"name": "groot-client",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "",
"keywords": "",
"author": "Chen Bin",
"author_email": "bin.chen1@mobilityasia.com.cn",
"download_url": "https://files.pythonhosted.org/packages/17/1d/bd13139ecf7ae78f72472c540b6eb59f859e21dac947f36bfa7fea123a20/groot-client-0.0.1.tar.gz",
"platform": null,
"description": "# Groot is a simple and kind-hearted tree people who longs for peace and has strong vitality\n\n## Installation\n\n```\n$ pip install -r requirements.txt\n\n$ python setup.py install\n```\n\n## Development\n\nThis project includes a number of helpers in the `Makefile` to streamline common development tasks.\n\n### Environment Setup\n\nThe following demonstrates setting up and working with a development environment:\n\n```\n### create a virtualenv for development\n\n$ make venv\n\n$ source .venv/bin/activate\n\n\n### run groot cli application\n\n$ groot --help\n\n\n### run pytest / coverage\n\n$ make test\n```\n\n\n### Releasing to PyPi\n\nBefore releasing to PyPi, you must configure your login credentials:\n\nVersion will be tagged a timestamp related to latest commit if you are in 'alpha' stage, \n such as: `0.0.1.dev20230407013444`\n**~/.pypirc**:\n\n```\n[distutils]\nindex-servers =\n pypi\n jfrog-cariad\n\n[pypi]\nrepository = https://upload.pypi.org/legacy/\nusername = __token__\npassword = <the api token generated by youself in pypi>\n\n[jfrog-cariad]\nrepository = https://jfrog-prod.maezia.com:443/artifactory/api/pypi/devops-pypi-internal-local/\nusername = <USERNAME>\npassword = <PASSWORD/API_TOKEN>\n```\n\nThen use the included helper function via the `Makefile`:\n\n```\n$ make dist\n\n$ make dist-upload\n```\n\n## Deployments\n\n### Docker\n\nIncluded is a basic `Dockerfile` for building and distributing `groot`,\nand can be built with the included `make` helper:\n\n```\n$ make docker\n\n$ docker run -it groot --help\n```\n",
"bugtrack_url": null,
"license": "unlicensed",
"summary": "Groot is a simple and kind-hearted tree people who longs for peace and has strong vitality",
"version": "0.0.1",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "168e4c9e835f6be496e044a684804fca0b2a4146c9145c1f05af0d43719d8bc3",
"md5": "5fe391ec401d7025bfc83974d6515cc5",
"sha256": "e68fb1da2d1de147ad537bf6a75aa046b7499c71074b404e8591651621db0f3e"
},
"downloads": -1,
"filename": "groot_client-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5fe391ec401d7025bfc83974d6515cc5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 15891,
"upload_time": "2023-04-07T05:52:05",
"upload_time_iso_8601": "2023-04-07T05:52:05.040458Z",
"url": "https://files.pythonhosted.org/packages/16/8e/4c9e835f6be496e044a684804fca0b2a4146c9145c1f05af0d43719d8bc3/groot_client-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "171dbd13139ecf7ae78f72472c540b6eb59f859e21dac947f36bfa7fea123a20",
"md5": "32a7dbd326f375165fdabb772addfe64",
"sha256": "14eaeb367fdae6b7a610838e3a6b255448b9fce7703248bc5ba786b28064c04c"
},
"downloads": -1,
"filename": "groot-client-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "32a7dbd326f375165fdabb772addfe64",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 11903,
"upload_time": "2023-04-07T05:52:06",
"upload_time_iso_8601": "2023-04-07T05:52:06.795118Z",
"url": "https://files.pythonhosted.org/packages/17/1d/bd13139ecf7ae78f72472c540b6eb59f859e21dac947f36bfa7fea123a20/groot-client-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-07 05:52:06",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "groot-client"
}
JSON