{"id":18283788,"url":"https://github.com/cfmtech/monitor-server-api","last_synced_at":"2025-04-05T07:31:05.642Z","repository":{"id":49730118,"uuid":"373852351","full_name":"CFMTech/monitor-server-api","owner":"CFMTech","description":"Monitor-server-api helps you to collect, historicize and exploit the data from your tests written with pytest and monitored with pytest-monitor.","archived":false,"fork":false,"pushed_at":"2022-08-21T14:33:44.000Z","size":152,"stargazers_count":3,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-21T00:11:37.098Z","etag":null,"topics":["cpu-monitoring","integration-testing","memory-monitoring","python","qatools","quality","rest-api"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CFMTech.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-06-04T13:35:06.000Z","updated_at":"2021-10-23T07:17:38.000Z","dependencies_parsed_at":"2022-09-06T03:31:38.644Z","dependency_job_id":null,"html_url":"https://github.com/CFMTech/monitor-server-api","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CFMTech%2Fmonitor-server-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CFMTech%2Fmonitor-server-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CFMTech%2Fmonitor-server-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CFMTech%2Fmonitor-server-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CFMTech","download_url":"https://codeload.github.com/CFMTech/monitor-server-api/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247305319,"owners_count":20917197,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cpu-monitoring","integration-testing","memory-monitoring","python","qatools","quality","rest-api"],"created_at":"2024-11-05T13:10:55.096Z","updated_at":"2025-04-05T07:31:00.631Z","avatar_url":"https://github.com/CFMTech.png","language":"Python","readme":"# monitor-server-api\n\n[![CircleCI](https://circleci.com/gh/CFMTech/monitor-server-api.svg?style=shield)](https://circleci.com/gh/CFMTech/monitor-server-api)\n![License](https://img.shields.io/badge/License-MIT-Blue.svg)\n[![Documentation Status](https://readthedocs.org/projects/monitor-server-api/badge/?version=latest)](https://monitor-server-api.readthedocs.io/en/latest/?badge=latest)\n[![PyPI](https://img.shields.io/pypi/v/monitor-server-api)](https://pypi.org/project/monitor-server-api/1.0.0/)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/monitor-server-api)\n[![Anaconda-Server Badge](https://anaconda.org/conda-forge/monitor-server-api/badges/platforms.svg)](https://anaconda.org/conda-forge/monitor-server-api)\n[![Anaconda-Server Badge](https://anaconda.org/conda-forge/monitor-server-api/badges/version.svg)](https://anaconda.org/conda-forge/monitor-server-api)\n\n## Features\n\nFor short, monitor-server-api helps you to collect, historicize and exploit the data from your tests\nwritten with pytest and monitored with pytest-monitor.\n\n* Centralize your tests results\n    * bring support for *pytest-xdist* and *pytest-parallel*\n* Easy data querying through specific queries\n* Integrated library for in-script queries\n\n## Usage\n\nThe server can be launched easily with any WSGI Framework.\nThe following lines can be used for a start:\n\n```bash\nbash $\u003e # Use it with sqlite (not recomended for production)\nbash $\u003e export DATABASE_PATH=/path/to/sqlite/db\nbash $\u003e uwsgi --http 0.0.0.0:8050 --workers 8 --process 8 --master \n--harakiri 60 --harakiri-verbose --need-app -w monitor_server_api.uwsgi \n--callable WSGI_SERVER --env DATABASE_PATH=${DATABASE_PATH} --env ENV=prod\n```\n\nIf you prefer using conda\n```bash\nbash $\u003e conda activate \u003cyour monitor-server-api env\u003e\nbash $\u003e # Setup the server to listen on port 8080, 8 workers, 60s max per request and using sqlite\nbash $\u003e launch-monitor-server.sh -p 8080 -t 60 -w 8 -u sqlite:////path/to/db\n```\n\nYou can validate that the server runs correctly by going to the root page of the server.\n\n## Documentation\n\n\u003e A full documentation with use cases and example is [available](https://monitor-server-api.readthedocs.io/en/latest/?badge=latest).\n\n## Installation\nReview the following installation instructions along with basic setup instructions.\n\nYou can install *monitor-server-api* via *conda* (through the `conda-forge` channel):\n\n    $ conda install monitor-server-api -c https://conda.anaconda.org/conda-forge\n\n Another possibility is to install *monitor-server-api* via `pip`_ from `PyPI`:\n\n    $ pip install monitor-server-api\n\n## Requirements\n\n### Monitor-Server-Api\n\nTo run, the monitor-server-api requires a valid Python 3.6+ interpreter. The following requirements\nare needed:\n\n* *flask-restx* (officially supported) OR *flask-restplus* (tested)\n* *flask-sqlalchemy*\n\nTesting requires *pytest-flask* and *pytest-cov* (along with *pytest* obviously).\n\n### Monitorlib\n\nThe monitorlib also requires a valid Python 3.6+ along with :\n\n* requests\n* pandas\n\n## Contributing\n\nContributions are very welcome. Tests are run with *[pytest](https://docs.pytest.org/en/latest/)*.\nBefore submitting a pull request, please ensure that:\n\n- both internal tests and examples are passing.\n- internal tests have been written if necessary.\n- if your contribution provides a new feature, make sure to provide an\n  example and update the documentation accordingly.\n\n### Issues\n\nIf you encounter any problem, please file an issue along with a detailed\ndescription.\n\nSee [contributing file](CONTRIBUTING.md) for more information.\n\n## License\n\n*monitor-server-api* is free, open-source software\nThis code is distributed under the ![MIT](https://img.shields.io/badge/License-MIT-Blue.svg) license.\n\n## Author\n\nThe main author of `monitor-server-api` is Jean-Sébastien Dieu, ]]who can be reached at dieu.jsebastien@yahoo.com.\nSee [AUTHORS file](AUTHORS) for more contributors.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcfmtech%2Fmonitor-server-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcfmtech%2Fmonitor-server-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcfmtech%2Fmonitor-server-api/lists"}