# Iseq resources
Scripts that allow you to:
1) Adding a new tool to the JSON file
2) Iterating over the tools in the JSON file and checking the latest version, and in the case of a new version, adding a tooltip to JIRA
3) Update existing tool/database record in JSON after updating tool/database
4) Update docker-versions.json in workflows repository
## Install
```
pip install iseqresources
```
## Requirements
- python >=3.6
- jira >= 3.3.0
- requests >= 2.22.0
- python-gitlab >= 3.7.0
## Adding a new tool
First specify if you want to add tool or database. Input JSON file (`--input-json`) is from gitlab repo at path `json/tools.json` or `json/databases.json`. Default is `json/tools.json`.
```
add_tool --tools
```
or
```
add_tool --databases
```
You can also run on a local file:
```
add_tool \
--input-json "/path/to/json/tools_or_databases.json"
```
It is better to add new tool directly to json file.
## Checking versions and add task to JIRA
Input JSON file (`--input-json` and `--info-json`) are from gitlab repo at path `json/tools.json` or `json/databases.json` and `json/info.json`. Default is `json/tools.json`.
```
check_versions --tools
```
or
```
check_versions --databases
```
You can also run on a local files:
```
check_versions \
--input-json "/path/to/json/tools_or_databases.json" \
--info-json "/path/to/json/info.json"
```
## Update existing tool/database record in JSON
Input JSON file (`--input-json`) is from gitlab repo at path `json/tools.json` or `json/databases.json`. Default is `json/tools.json`.
```
update_record --tools
```
or
```
update_record --databases
```
You can also run on a local file:
```
update_record \
--input-json "/path/to/json/tools_or_databases.json"
```
## Update docker-versions.json in workflows repository (based on tools.json)
After updating tools.json at `json/tools.json` you need to get into root directory of workflows repository and type in bash:
```
update_docker_versions
```
For possible customization options and help use flag `-h`
```
update_docker_versions -h
```
Raw data
{
"_id": null,
"home_page": "https://gitlab.com/intelliseq/iseqresources",
"name": "iseqresources",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Mateusz Marynowski, Olaf Tomaszewski",
"author_email": "mateusz.marynowski@intelliseq.pl, olaf.tomaszewski@intelliseq.pl",
"download_url": "https://files.pythonhosted.org/packages/4e/c1/345024c67614fe56191221f23dae96654b392a5695128bb437fdb375cb8c/iseqresources-0.0.15.tar.gz",
"platform": null,
"description": "# Iseq resources\n\nScripts that allow you to:\n1) Adding a new tool to the JSON file\n2) Iterating over the tools in the JSON file and checking the latest version, and in the case of a new version, adding a tooltip to JIRA\n3) Update existing tool/database record in JSON after updating tool/database\n4) Update docker-versions.json in workflows repository\n\n## Install\n\n```\npip install iseqresources\n```\n\n## Requirements\n\n- python >=3.6\n- jira >= 3.3.0\n- requests >= 2.22.0\n- python-gitlab >= 3.7.0\n\n\n## Adding a new tool\n\nFirst specify if you want to add tool or database. Input JSON file (`--input-json`) is from gitlab repo at path `json/tools.json` or `json/databases.json`. Default is `json/tools.json`.\n\n```\nadd_tool --tools\n```\nor\n```\nadd_tool --databases\n```\n\nYou can also run on a local file:\n\n```\nadd_tool \\\n --input-json \"/path/to/json/tools_or_databases.json\"\n```\n\nIt is better to add new tool directly to json file.\n\n## Checking versions and add task to JIRA\n\nInput JSON file (`--input-json` and `--info-json`) are from gitlab repo at path `json/tools.json` or `json/databases.json` and `json/info.json`. Default is `json/tools.json`.\n\n```\ncheck_versions --tools\n```\nor\n```\ncheck_versions --databases\n```\n\nYou can also run on a local files:\n\n```\ncheck_versions \\\n --input-json \"/path/to/json/tools_or_databases.json\" \\\n --info-json \"/path/to/json/info.json\"\n```\n\n## Update existing tool/database record in JSON\n\nInput JSON file (`--input-json`) is from gitlab repo at path `json/tools.json` or `json/databases.json`. Default is `json/tools.json`.\n\n```\nupdate_record --tools\n```\nor\n```\nupdate_record --databases\n```\n\nYou can also run on a local file:\n\n```\nupdate_record \\\n --input-json \"/path/to/json/tools_or_databases.json\"\n```\n\n## Update docker-versions.json in workflows repository (based on tools.json)\n\nAfter updating tools.json at `json/tools.json` you need to get into root directory of workflows repository and type in bash:\n\n```\nupdate_docker_versions\n```\n\nFor possible customization options and help use flag `-h`\n\n```\nupdate_docker_versions -h\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "Package for adding new tools to json file, checking their versions and creating tasks in JIRA",
"version": "0.0.15",
"project_urls": {
"Homepage": "https://gitlab.com/intelliseq/iseqresources"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ccfd0e418e3d590e470b403d3c09897a0519c1d9660ef6c60cfd48b586b8ea9c",
"md5": "09c6ae7dc9a741c1414f639caf1e87b7",
"sha256": "b595e27ae78c2584b3d3a8d7c140e66c0f6e57536d589de4c3456177f99b41c6"
},
"downloads": -1,
"filename": "iseqresources-0.0.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "09c6ae7dc9a741c1414f639caf1e87b7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 14767,
"upload_time": "2023-07-28T15:17:28",
"upload_time_iso_8601": "2023-07-28T15:17:28.416360Z",
"url": "https://files.pythonhosted.org/packages/cc/fd/0e418e3d590e470b403d3c09897a0519c1d9660ef6c60cfd48b586b8ea9c/iseqresources-0.0.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4ec1345024c67614fe56191221f23dae96654b392a5695128bb437fdb375cb8c",
"md5": "926d0ad6691250743e8cf4114b7e28ac",
"sha256": "dc95d9ae6a61126036f005a1c285fa858b847f44c3240ee71de5e44a7d88ea3f"
},
"downloads": -1,
"filename": "iseqresources-0.0.15.tar.gz",
"has_sig": false,
"md5_digest": "926d0ad6691250743e8cf4114b7e28ac",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 11388,
"upload_time": "2023-07-28T15:17:31",
"upload_time_iso_8601": "2023-07-28T15:17:31.072407Z",
"url": "https://files.pythonhosted.org/packages/4e/c1/345024c67614fe56191221f23dae96654b392a5695128bb437fdb375cb8c/iseqresources-0.0.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-28 15:17:31",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "intelliseq",
"gitlab_project": "iseqresources",
"lcname": "iseqresources"
}