# Sinkove Python Library
This repository contains Sinkove's Python client.
## Installing the project
#### Requirements
- **python** >= 3.10
- **make** >= 4.3
1. Clone this repository.
2. Go to the project folder and run the following command to create a new virtual environment.
```bash
python -m venv .venv
```
3. Activate your new virtual environment.
```bash
source ./venv/bin/activate
```
4. Configure your environmet using make.
```bash
make setup
```
## Tests
### Running tests on your system
#### Dependencies
- **make** >= 4.3
- **python** == 3.10
```bash
make setup
make test
```
### Running test on docker
- **make** >= 4.3
- **docker** >= 20.10.17
```bash
pip install dagger-io
make dagger-test
```
## Releases
We use `bumpversion` for version management. `bumpversion` is a tool that
creates a new git tag for the current release and changes the code to
replace the version where it's necessary. After merging all the changes
into the branch main, to release a new version, follow these steps:
1. Update the branch main locally.
```bash
git checkout main
git pull origin main
```
2. Activate your previously configured virtual environment.
```bash
source .venv/bin/activate
```
3. Run `bumpversion` according to the **semantic version** pattern. You
have the options `major`, `minor` and `patch`.
```bash
bumpversion minor
```
4. Push the generated tag to the remote.
```bash
git push origin main --tags
```
5. The CI/CD pipeline is configured to deploy a new package everytime a
new tag is pushed. You can check the pipeline progress on the Github Actions UI.
Raw data
{
"_id": null,
"home_page": "https://github.com/sinkove/sk-sdk-python.git",
"name": "sinkove",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "datasets,machinelearning,medical,images,sdk,synthetic",
"author": "Luan",
"author_email": "luan@sinkove.com",
"download_url": "https://files.pythonhosted.org/packages/a8/84/e2d3ea94d7b11888fa87627f330b9e89421ff12e47f69c3d4632047954f3/sinkove-0.0.2.tar.gz",
"platform": null,
"description": "# Sinkove Python Library\n\nThis repository contains Sinkove's Python client.\n\n## Installing the project \n\n#### Requirements\n- **python** >= 3.10\n- **make** >= 4.3\n\n1. Clone this repository.\n2. Go to the project folder and run the following command to create a new virtual environment.\n\t```bash\n\tpython -m venv .venv\n\t```\n3. Activate your new virtual environment.\n\t```bash\n\tsource ./venv/bin/activate\n\t```\n4. Configure your environmet using make.\n\t```bash\n\tmake setup \n\t```\n\n## Tests\n\n### Running tests on your system\n\n#### Dependencies\n\n- **make** >= 4.3\n- **python** == 3.10\n\n```bash\nmake setup\nmake test\n```\n\n### Running test on docker\n\n- **make** >= 4.3\n- **docker** >= 20.10.17\n\n```bash\npip install dagger-io\nmake dagger-test\n```\n\n## Releases\n\nWe use `bumpversion` for version management. `bumpversion` is a tool that\ncreates a new git tag for the current release and changes the code to\nreplace the version where it's necessary. After merging all the changes\ninto the branch main, to release a new version, follow these steps:\n\n1. Update the branch main locally.\n ```bash\n git checkout main\n git pull origin main\n ```\n2. Activate your previously configured virtual environment.\n ```bash\n source .venv/bin/activate\n ```\n3. Run `bumpversion` according to the **semantic version** pattern. You\n\thave the options `major`, `minor` and `patch`.\n ```bash\n bumpversion minor\n ```\n4. Push the generated tag to the remote.\n ```bash\n git push origin main --tags\n ```\n5. The CI/CD pipeline is configured to deploy a new package everytime a\nnew tag is pushed. You can check the pipeline progress on the Github Actions UI.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Library for interacting with Sinkove datasets",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/sinkove/sk-sdk-python.git"
},
"split_keywords": [
"datasets",
"machinelearning",
"medical",
"images",
"sdk",
"synthetic"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "40c16d057d440f6dbb9ecf78cc2d228af1fac0739cccac590db88daa290713cf",
"md5": "34a1d220f54310ce8a4f36dd8ce2071e",
"sha256": "680e0c24a76d9aed63e5cf21943686eafb8a6e85cc559bec3c2d041c8caf8e7c"
},
"downloads": -1,
"filename": "sinkove-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "34a1d220f54310ce8a4f36dd8ce2071e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 2566,
"upload_time": "2023-07-03T23:28:43",
"upload_time_iso_8601": "2023-07-03T23:28:43.496217Z",
"url": "https://files.pythonhosted.org/packages/40/c1/6d057d440f6dbb9ecf78cc2d228af1fac0739cccac590db88daa290713cf/sinkove-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a884e2d3ea94d7b11888fa87627f330b9e89421ff12e47f69c3d4632047954f3",
"md5": "722458598716c5f092b276abfa5fa614",
"sha256": "e8a304507fcfeeb8b2f30ef4ea307c9b47cafd822d9b4984a17a037de4c4f08c"
},
"downloads": -1,
"filename": "sinkove-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "722458598716c5f092b276abfa5fa614",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 3055,
"upload_time": "2023-07-03T23:28:45",
"upload_time_iso_8601": "2023-07-03T23:28:45.078704Z",
"url": "https://files.pythonhosted.org/packages/a8/84/e2d3ea94d7b11888fa87627f330b9e89421ff12e47f69c3d4632047954f3/sinkove-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-03 23:28:45",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "sinkove",
"github_project": "sk-sdk-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "sinkove"
}
JSON
