# perftracker-lib
A client library for the [perftracker](https://github.com/perfguru87/perftracker) and a set of libraries for performance testing
## Supported python version
python2.7
python3.0+
## Building and installing the perftracker-client python package
Installing from pypi.org:
```
pip install perftrackerlib
```
Installing from sources:
```
python3 ./setup.py build
python3 ./setup.py install
```
## Usage Examples
### Python-written Test Suites
Minimalistic test suite:
```
python3 ./examples/pt_suite_example_minimal.py --pt-title="Website suite run" --pt-url http://perftracker.localdomain:9000
```
Simulate a 'website' suite run and upload results:
```
python3 ./examples/pt_suite_example_fake.py -v --pt-title="Website suite run" --pt-project="Default project" --pt-url http://perftracker.localdomain:9000
```
Use code like `examples/pt_suite_example_populate.sh` to mass populate perftracker with fake data
### Upload pre-generated files with tests results:
Sometimes you don't want to write a python suite and just grab some files and export results. In this case
you can use the pt-suite-uploader.py tool to parse test/json files (or even launch an external tool) and then
upload results:
```
python3 ./tools/pt-suite-uploader.py -f ./examples/data/sample.txt
python3 ./tools/pt-suite-uploader.py -f -j ./examples/data/sample.json
python3 ./tools/pt-suite-uploader.py -- /bin/echo "tag: my test; score: 2.3;"
...
```
### Manage artifacts (i.e. jobs and tests attachments)
The perftracker server supports [artifact management](https://github.com/perfguru87/perftracker)
An artifact is a file which can be stored as blob file and linked to test or job run, for example
it can be test or job log, dump or some test data. Many to many links are allowed
There are three ways how clients can managet the artifacts:
1. perftracker REST API
2. perftrackerlib/client.py - ptArfitact() class
3. the ./tools/pt-artifact-ctl.py tool (see --help)
Short introuduction to pt-artifact-ctl.py:
a) Help
```
pt-artifact-ctl.py --help
Usage: pt-artifact-ctl.py [options] command [command parameters]
Description:
pt-artifact-ctl.py [options] upload ARTIFACT_FILE_TO_UPLOAD [ARTIFACT_UUID]
pt-artifact-ctl.py [options] update ARTIFACT_UUID
pt-artifact-ctl.py [options] delete ARTIFACT_UUID
pt-artifact-ctl.py [options] info ARTIFACT_UUID
pt-artifact-ctl.py [options] link ARTIFACT_UUID OBJECT_UUID
pt-artifact-ctl.py [options] unlink ARTIFACT_UUID OBJECT_UUID
pt-artifact-ctl.py [options] list [LIMIT]
pt-artifact-ctl.py [options] download ARTIFACT_UUID ARTIFACT_FILE_TO_SAVE
Options:
-h, --help show this help message and exit
-v, --verbose enable verbose mode
-p PT_SERVER_URL, --pt-server-url=PT_SERVER_URL
perftracker url, default http://127.0.0.1:9000
-d DESCRIPTION, --description=DESCRIPTION
artifact description
-m MIME, --mime=MIME artifact mime type, default is guessed or
'application/octet-stream'
-f FILENAME, --filename=FILENAME
override artifact file name by given name
-z, --compression inline decompression on every file view or
download
-i, --inline inline view in browser (do not download on click)
-t TTL, --ttl=TTL time to live (days), default=180, 0 - infinite
```
b) Upload an artifact and link in to the test with uuid = $TEST_UUID
```
./pt-artifact-ctl.py upload ~/my_test.log
./pt-artifact-ctl.py link $ARTIFACT_UUID $TEST_UUID
```
c) Upload an artifact, set infinite time to live, enable dynamic compression and enable inline view in the browser
```
./pt-artifact-ctl.py upload ~/my_test.log -iz -t 0
```
## Contributing a patch
Make a change and test your code before commit:
```
python ./test.py
```
## Release notes
See [http://www.perftracker.org/client/#Release_Notes](http://www.perftracker.org/client/#Release_Notes)
Raw data
{
"_id": null,
"home_page": "http://www.perftracker.org",
"name": "perftrackerlib",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "performance tests tools selenium webdriver perftracker client",
"author": "perfguru87",
"author_email": "perfguru87@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/5f/d5/f3b289022ccf50555ee30ba4aa4a82500d0a296ca58f7eabc62597ceec55/perftrackerlib-0.1.8.tar.gz",
"platform": null,
"description": "# perftracker-lib\nA client library for the [perftracker](https://github.com/perfguru87/perftracker) and a set of libraries for performance testing\n\n## Supported python version\n\npython2.7\n\npython3.0+\n\n## Building and installing the perftracker-client python package\n\nInstalling from pypi.org:\n\n```\npip install perftrackerlib\n```\n\nInstalling from sources:\n\n```\npython3 ./setup.py build\npython3 ./setup.py install\n```\n\n## Usage Examples\n\n### Python-written Test Suites\n\nMinimalistic test suite:\n```\npython3 ./examples/pt_suite_example_minimal.py --pt-title=\"Website suite run\" --pt-url http://perftracker.localdomain:9000\n```\n\nSimulate a 'website' suite run and upload results:\n```\npython3 ./examples/pt_suite_example_fake.py -v --pt-title=\"Website suite run\" --pt-project=\"Default project\" --pt-url http://perftracker.localdomain:9000\n```\n\nUse code like `examples/pt_suite_example_populate.sh` to mass populate perftracker with fake data\n\n### Upload pre-generated files with tests results:\n\nSometimes you don't want to write a python suite and just grab some files and export results. In this case\nyou can use the pt-suite-uploader.py tool to parse test/json files (or even launch an external tool) and then\nupload results:\n```\npython3 ./tools/pt-suite-uploader.py -f ./examples/data/sample.txt\npython3 ./tools/pt-suite-uploader.py -f -j ./examples/data/sample.json\npython3 ./tools/pt-suite-uploader.py -- /bin/echo \"tag: my test; score: 2.3;\"\n...\n```\n\n### Manage artifacts (i.e. jobs and tests attachments)\n\nThe perftracker server supports [artifact management](https://github.com/perfguru87/perftracker)\nAn artifact is a file which can be stored as blob file and linked to test or job run, for example\nit can be test or job log, dump or some test data. Many to many links are allowed\n\nThere are three ways how clients can managet the artifacts:\n1. perftracker REST API\n2. perftrackerlib/client.py - ptArfitact() class\n3. the ./tools/pt-artifact-ctl.py tool (see --help)\n\nShort introuduction to pt-artifact-ctl.py:\n\na) Help\n\n```\npt-artifact-ctl.py --help\nUsage: pt-artifact-ctl.py [options] command [command parameters]\n\nDescription:\n pt-artifact-ctl.py [options] upload ARTIFACT_FILE_TO_UPLOAD [ARTIFACT_UUID]\n pt-artifact-ctl.py [options] update ARTIFACT_UUID\n pt-artifact-ctl.py [options] delete ARTIFACT_UUID\n pt-artifact-ctl.py [options] info ARTIFACT_UUID\n pt-artifact-ctl.py [options] link ARTIFACT_UUID OBJECT_UUID\n pt-artifact-ctl.py [options] unlink ARTIFACT_UUID OBJECT_UUID\n pt-artifact-ctl.py [options] list [LIMIT]\n pt-artifact-ctl.py [options] download ARTIFACT_UUID ARTIFACT_FILE_TO_SAVE\n\nOptions:\n -h, --help show this help message and exit\n -v, --verbose enable verbose mode\n -p PT_SERVER_URL, --pt-server-url=PT_SERVER_URL\n perftracker url, default http://127.0.0.1:9000\n -d DESCRIPTION, --description=DESCRIPTION\n artifact description\n -m MIME, --mime=MIME artifact mime type, default is guessed or\n 'application/octet-stream'\n -f FILENAME, --filename=FILENAME\n override artifact file name by given name\n -z, --compression inline decompression on every file view or\n download\n -i, --inline inline view in browser (do not download on click)\n -t TTL, --ttl=TTL time to live (days), default=180, 0 - infinite\n```\n\nb) Upload an artifact and link in to the test with uuid = $TEST_UUID\n\n```\n./pt-artifact-ctl.py upload ~/my_test.log\n./pt-artifact-ctl.py link $ARTIFACT_UUID $TEST_UUID\n```\n\nc) Upload an artifact, set infinite time to live, enable dynamic compression and enable inline view in the browser\n\n```\n./pt-artifact-ctl.py upload ~/my_test.log -iz -t 0\n```\n\n## Contributing a patch\n\nMake a change and test your code before commit:\n```\npython ./test.py\n```\n\n## Release notes\n\nSee [http://www.perftracker.org/client/#Release_Notes](http://www.perftracker.org/client/#Release_Notes)\n\n\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Python package with perftracker client, tools, tests and libraries",
"version": "0.1.8",
"project_urls": {
"Homepage": "http://www.perftracker.org"
},
"split_keywords": [
"performance",
"tests",
"tools",
"selenium",
"webdriver",
"perftracker",
"client"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f3f39b246396ea408225276f7de8d09da4272c835783fbe626f4e85e7133f7ac",
"md5": "ea6e0da9c3b85c359ce670f58f4dbed4",
"sha256": "b7edf720a89366fe12d0e5efb457dcc941b84a6771aced3414306e7694cff480"
},
"downloads": -1,
"filename": "perftrackerlib-0.1.8-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "ea6e0da9c3b85c359ce670f58f4dbed4",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 184017,
"upload_time": "2023-08-21T19:40:16",
"upload_time_iso_8601": "2023-08-21T19:40:16.189905Z",
"url": "https://files.pythonhosted.org/packages/f3/f3/9b246396ea408225276f7de8d09da4272c835783fbe626f4e85e7133f7ac/perftrackerlib-0.1.8-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5fd5f3b289022ccf50555ee30ba4aa4a82500d0a296ca58f7eabc62597ceec55",
"md5": "a612d0b6dce171a0ffb56badac336f57",
"sha256": "6229ec25677b51389414d72f622261e3faf880db3bacc125fa52a5b3946d256b"
},
"downloads": -1,
"filename": "perftrackerlib-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "a612d0b6dce171a0ffb56badac336f57",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 177917,
"upload_time": "2023-08-21T19:40:46",
"upload_time_iso_8601": "2023-08-21T19:40:46.911596Z",
"url": "https://files.pythonhosted.org/packages/5f/d5/f3b289022ccf50555ee30ba4aa4a82500d0a296ca58f7eabc62597ceec55/perftrackerlib-0.1.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-21 19:40:46",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "perftrackerlib"
}
JSON