{height=250px}
# Talp Pages
TALP Pages is a collection of Python scripts to postprocess the `json` outputs of [DLB TALP](https://pm.bsc.es/ftp/dlb/doc/user-guide/intro.html#talp-tracking-application-live-performance) and Gitlab pipeline snippets [that can be included](https://docs.gitlab.com/ee/ci/yaml/#include) in your project.
This makes it easy to integrate TALP into your CI/CD setup and run Continous Benchmarking without having to code up your own solution.
**We provide:**
- talp_pages: Command line tool to generate static html pages
- Artifact management: A easy way to use Gitlab Artifacts to generate time series data plots.
- Reusable Jobs that easily integrate into a existing Gitlab CI enviroment
## Use python package
Talp-Pages is written in Python (3.9+). We rely on [poetry](https://python-poetry.org/) for packaging.
To use, simply install via:
```pip install talp-pages```
From there you should have the following command-line tools available:
- `talp_report`
- `talp_add_to_db`
- `talp_badge`
- `talp_report_ts`
- `talp_pages`
- `talp_download_artifacts`
## Use Gitlab Jobs
This section currently is not completly done, but we provide examples on how to use the jobs below:
```yaml
talp-performance-run:
stage: performance
image: python:3.12-bullseye
script:
- python generate_talp_json.py
artifacts:
paths:
- talp.json
include:
- remote: https://pm.bsc.es/gitlab/dlb/talp-pages/-/raw/main/templates/add-to-db/template.yml
inputs:
stage: deploy
generating_job: talp-performance-run
talp_output: ./talp.json
enviroment: production
gitlab_url: https://gitlab.com
project_name: valentin.seitz1/sample-application
dlb_home: ./dlb_talp
job_name: talp-create-artifacts
- remote: https://pm.bsc.es/gitlab/dlb/talp-pages/-/raw/main/templates/generate-html/template.yml
inputs:
stage: deploy
generating_job: talp-create-artifacts
enviroment: production
dlb_home: ./dlb_talp
job_name: talp-gen-html
```
## License
Talp-Pages is available under the General Public License v3.0.
Raw data
{
"_id": null,
"home_page": "https://pm.bsc.es/gitlab/dlb/talp-pages/",
"name": "talp-pages",
"maintainer": "Valentin Seitz",
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": "valentin.seitz@bsc.es",
"keywords": "HPC, Performance Analysis, Profiling, Continuous Performance Analysis",
"author": "Valentin Seitz",
"author_email": "valentin.seitz@bsc.es",
"download_url": "https://files.pythonhosted.org/packages/58/b6/08975195d98f964529fbe64180ab03a5bb0beea54967bd5d2f3964d62b08/talp_pages-3.4.0a1.tar.gz",
"platform": null,
"description": "{height=250px}\n\n# Talp Pages\n\nTALP Pages is a collection of Python scripts to postprocess the `json` outputs of [DLB TALP](https://pm.bsc.es/ftp/dlb/doc/user-guide/intro.html#talp-tracking-application-live-performance) and Gitlab pipeline snippets [that can be included](https://docs.gitlab.com/ee/ci/yaml/#include) in your project.\nThis makes it easy to integrate TALP into your CI/CD setup and run Continous Benchmarking without having to code up your own solution.\n\n**We provide:**\n\n- talp_pages: Command line tool to generate static html pages\n- Artifact management: A easy way to use Gitlab Artifacts to generate time series data plots.\n- Reusable Jobs that easily integrate into a existing Gitlab CI enviroment\n\n## Use python package\n\nTalp-Pages is written in Python (3.9+). We rely on [poetry](https://python-poetry.org/) for packaging.\nTo use, simply install via:\n\n```pip install talp-pages```\n\nFrom there you should have the following command-line tools available:\n\n- `talp_report`\n- `talp_add_to_db`\n- `talp_badge`\n- `talp_report_ts`\n- `talp_pages`\n- `talp_download_artifacts`\n\n## Use Gitlab Jobs\n\nThis section currently is not completly done, but we provide examples on how to use the jobs below:\n\n```yaml\n\ntalp-performance-run:\n stage: performance\n image: python:3.12-bullseye\n script:\n - python generate_talp_json.py\n artifacts:\n paths:\n - talp.json\n\n\ninclude:\n - remote: https://pm.bsc.es/gitlab/dlb/talp-pages/-/raw/main/templates/add-to-db/template.yml\n inputs:\n stage: deploy\n generating_job: talp-performance-run\n talp_output: ./talp.json\n enviroment: production\n gitlab_url: https://gitlab.com\n project_name: valentin.seitz1/sample-application\n dlb_home: ./dlb_talp\n job_name: talp-create-artifacts\n - remote: https://pm.bsc.es/gitlab/dlb/talp-pages/-/raw/main/templates/generate-html/template.yml\n inputs:\n stage: deploy\n generating_job: talp-create-artifacts\n enviroment: production\n dlb_home: ./dlb_talp\n job_name: talp-gen-html\n```\n\n## License\n\nTalp-Pages is available under the General Public License v3.0.\n",
"bugtrack_url": null,
"license": "GPL-3.0-only",
"summary": "Command line tools to generate performance reports using the TALP module of DLB",
"version": "3.4.0a1",
"project_urls": {
"Homepage": "https://pm.bsc.es/gitlab/dlb/talp-pages/",
"Repository": "https://pm.bsc.es/gitlab/dlb/talp-pages/"
},
"split_keywords": [
"hpc",
" performance analysis",
" profiling",
" continuous performance analysis"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "aadaa3d51567052aa21d6008848c8d1632368016fc029d297a132d2260f7c2fa",
"md5": "18414ddfcd9c3c30de398a2d5b43e186",
"sha256": "8187d69319464dab579877c8e1d8ee2b6a946cb98b6548aafb761973331812f7"
},
"downloads": -1,
"filename": "talp_pages-3.4.0a1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "18414ddfcd9c3c30de398a2d5b43e186",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 1097924,
"upload_time": "2024-05-09T09:33:53",
"upload_time_iso_8601": "2024-05-09T09:33:53.895583Z",
"url": "https://files.pythonhosted.org/packages/aa/da/a3d51567052aa21d6008848c8d1632368016fc029d297a132d2260f7c2fa/talp_pages-3.4.0a1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "58b608975195d98f964529fbe64180ab03a5bb0beea54967bd5d2f3964d62b08",
"md5": "74927e146e26263b9a37b2932c7279fd",
"sha256": "dd0e2805fdaada445881b57a92bc19c05f82dd837ce190f33d441907952ef57e"
},
"downloads": -1,
"filename": "talp_pages-3.4.0a1.tar.gz",
"has_sig": false,
"md5_digest": "74927e146e26263b9a37b2932c7279fd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 1094424,
"upload_time": "2024-05-09T09:33:56",
"upload_time_iso_8601": "2024-05-09T09:33:56.585147Z",
"url": "https://files.pythonhosted.org/packages/58/b6/08975195d98f964529fbe64180ab03a5bb0beea54967bd5d2f3964d62b08/talp_pages-3.4.0a1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-09 09:33:56",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "talp-pages"
}
JSON