monitor-server-api


Namemonitor-server-api JSON
Version 1.0.0 PyPI version JSON
download
home_pagehttps://monitor-server-api.readthedocs.io/
SummaryA REST API that can be used a central point for collecting metrics from pytest-monitor.
upload_time2021-06-11 08:27:43
maintainerJean-Sébastien Dieu
docs_urlNone
authorJean-Sébastien Dieu
requires_python>=3.6
licenseMIT
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # monitor-server-api

[![CircleCI](https://circleci.com/gh/CFMTech/monitor-server-api.svg?style=svg)](https://circleci.com/gh/CFMTech/monitor-server-api)
![License](https://img.shields.io/badge/License-MIT-Blue.svg)
[![Documentation Status](https://readthedocs.org/projects/monitor-server-api/badge/?version=latest)](https://monitor-server-api.readthedocs.io/en/latest/?badge=latest)

## Features

For short, monitor-server-api helps you to collect, historicize and exploit the data from your tests
written with pytest and monitored with pytest-monitor.

* Centralize your tests results
    * bring support for *pytest-xdist* and *pytest-parallel*
* Easy data querying through specific queries
* Integrated library for in-script queries

## Usage

The server can be launched easily with any WSGI Framework.
The following lines can be used for a start:

```bash
bash $> # Use it with sqlite (not recomended for production)
bash $> export DATABASE_PATH=/path/to/sqlite/db
bash $> uwsgi --http 0.0.0.0:8050 --workers 8 --process 8 --master 
--harakiri 60 --harakiri-verbose --need-app -w monitor_server_api.uwsgi 
--callable WSGI_SERVER --env DATABASE_PATH=${DATABASE_PATH} --env ENV=prod
```

If you prefer using conda
```bash
bash $> conda activate <your monitor-server-api env>
bash $> launch-monitor-server.sh -p 8080 -t 60 -w 8 -u sqlite:////path/to/db
```

You can validate that the server runs correctly by going to the root page of the server.

## Documentation

> A full documentation with use cases and example is [available](https://link.to.readthedocs.org).

## Installation
Review the following installation instructions along with basic setup instructions.

You can install *monitor-server-api* via *conda* (through the `conda-forge` channel):

    $ conda install monitor-server-api -c https://conda.anaconda.org/conda-forge

 Another possibility is to install *monitor-server-api* via `pip`_ from `PyPI`:

    $ pip install monitor-server-api

## Requirements

### Monitor-Server-Api

To run, the monitor-server-api requires a valid Python 3.6+ interpreter. The following requirements
are needed:

* *flask-restx* (officially supported) OR *flask-restplus* (tested)
* *flask-sqlalchemy*

Testing requires *pytest-flask* and *pytest-cov* (along with *pytest* obviously).

### Monitorlib

The monitorlib also requires a valid Python 3.6+ along with :

* requests
* pandas

## Contributing

Contributions are very welcome. Tests are run with *[pytest](https://docs.pytest.org/en/latest/)*.
Before submitting a pull request, please ensure that:

- both internal tests and examples are passing.
- internal tests have been written if necessary.
- if your contribution provides a new feature, make sure to provide an
  example and update the documentation accordingly.

### Issues

If you encounter any problem, please file an issue along with a detailed
description.

See [contributing file](CONTRIBUTING.md) for more information.

## License

*monitor-server-api* is free, open-source software
This code is distributed under the ![MIT](https://img.shields.io/badge/License-MIT-Blue.svg) license.

## Author

The main author of `monitor-server-api` is Jean-Sébastien Dieu, ]]who can be reached at dieu.jsebastien@yahoo.com.
See [AUTHORS file](AUTHORS) for more contributors.



            

Raw data

            {
    "_id": null,
    "home_page": "https://monitor-server-api.readthedocs.io/",
    "name": "monitor-server-api",
    "maintainer": "Jean-S\u00e9bastien Dieu",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "dieu.jsebastien@yahoo.com",
    "keywords": "",
    "author": "Jean-S\u00e9bastien Dieu",
    "author_email": "dieu.jsebastien@yahoo.com",
    "download_url": "https://files.pythonhosted.org/packages/f8/7d/d516de49b87f96f1212de5dcd15ea02568056c922c9ab6d2a363a1ba41cc/monitor-server-api-1.0.0.tar.gz",
    "platform": "",
    "description": "# monitor-server-api\n\n[![CircleCI](https://circleci.com/gh/CFMTech/monitor-server-api.svg?style=svg)](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\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 $> # Use it with sqlite (not recomended for production)\nbash $> export DATABASE_PATH=/path/to/sqlite/db\nbash $> 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 $> conda activate <your monitor-server-api env>\nbash $> 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> A full documentation with use cases and example is [available](https://link.to.readthedocs.org).\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\u00e9bastien Dieu, ]]who can be reached at dieu.jsebastien@yahoo.com.\nSee [AUTHORS file](AUTHORS) for more contributors.\n\n\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A REST API that can be used a central point for collecting metrics from pytest-monitor.",
    "version": "1.0.0",
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "481a1781724838badf97ab98361c6508",
                "sha256": "afe94239cca316f6ed554180eb92611e3958141d81b84255c30e3d7306366f34"
            },
            "downloads": -1,
            "filename": "monitor_server_api-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "481a1781724838badf97ab98361c6508",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 50557,
            "upload_time": "2021-06-11T08:27:41",
            "upload_time_iso_8601": "2021-06-11T08:27:41.923784Z",
            "url": "https://files.pythonhosted.org/packages/c5/6f/96d668a53cdb1f341ae7f27faff10d14622e9e4e8a226fe8aa8b162cf971/monitor_server_api-1.0.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "246a15525193fb6b3618afc4c151335f",
                "sha256": "4ef28cf26db464e65160b6672650d36de0cceaae9004777bd2d238a712e2785f"
            },
            "downloads": -1,
            "filename": "monitor-server-api-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "246a15525193fb6b3618afc4c151335f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 41228,
            "upload_time": "2021-06-11T08:27:43",
            "upload_time_iso_8601": "2021-06-11T08:27:43.046050Z",
            "url": "https://files.pythonhosted.org/packages/f8/7d/d516de49b87f96f1212de5dcd15ea02568056c922c9ab6d2a363a1ba41cc/monitor-server-api-1.0.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-06-11 08:27:43",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "monitor-server-api"
}
        
Elapsed time: 0.31108s