# mustlink
A python wrapper for the WebMUST API (mustlink)
This is a simple wrapper in python for the [WebMUST](https://www.esa.int/Enabling_Support/Operations/WebMUST_br_A_web-based_client_for_MUST) API.
## Dependencies
The following dependencies must be met:
- python 3
- matplotlib
- pandas
- pyyaml
- requests
## Installation
### pip
```pip install mustlink```
should do the job, although creating a dedicated environment is recommended (see below).
### conda
First, clone this repository. If you are using conda, the dependencies can be installed in a new environment using the provided environment file:
```conda env create -f environment.yml```
The newly created environment can be activated with:
```conda activate mustlink```
Otherwise, please make sure the dependencies are installed with your system package manager, or a tool like `pip`. Use of a conda environment or virtualenv is recommended!
The package can then be installed with:
```python setup.py install```
## URL
The URL for the WebMUST instance in use can be specified when instantiating the Must class. If none is given, a default URL is used. For example:
```python
must = mustlink.Must(url='https://mustinstance.com/mustlink')
```
## Authentication
Access to WebMUST needs authentication. This is controlled by a config file which can be pointed to by the `config_file` parameter when instantiating the Must class, for example:
```python
must = mustlink.Must(config_file='path_to/config.file')
```
If nothing is specified, a file `mustlink.yml` is looked for in paths pointed to by the environment variables `APPDATA`, `XDG_CONFIG_HOME` or in the `.config` folder in the user's home directory.
The configuration file should be in YAML format and contain the username and password as follows:
```yaml
user:
login: "userone"
password: "blah"
```
## Example
The Jupyter notebook included with this repository shows an example of how to use the code. Note that not all API functions are wrapped by this library, but only those that are commonly used. To view the notebook, click [here](https://nbviewer.jupyter.org/github/msbentley/mustlink/blob/master/mustlink_example.ipynb).
Raw data
{
"_id": null,
"home_page": "https://github.com/msbentley/mustlink",
"name": "mustlink",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.0",
"maintainer_email": "",
"keywords": "telemetry,MUST,ESA",
"author": "Mark S. Bentley",
"author_email": "mark@lunartech.org",
"download_url": "https://files.pythonhosted.org/packages/fb/8f/10d104011eb494f8d9c937addbf891f0ea6acdab56c41353b90b41270a33/mustlink-0.3.2.tar.gz",
"platform": null,
"description": "# mustlink\nA python wrapper for the WebMUST API (mustlink)\n\nThis is a simple wrapper in python for the [WebMUST](https://www.esa.int/Enabling_Support/Operations/WebMUST_br_A_web-based_client_for_MUST) API.\n\n## Dependencies\n\nThe following dependencies must be met:\n- python 3\n- matplotlib\n- pandas\n- pyyaml\n- requests\n\n## Installation\n\n### pip\n\n```pip install mustlink```\n\nshould do the job, although creating a dedicated environment is recommended (see below).\n\n### conda\n\nFirst, clone this repository. If you are using conda, the dependencies can be installed in a new environment using the provided environment file:\n\n```conda env create -f environment.yml```\n\nThe newly created environment can be activated with:\n\n```conda activate mustlink```\n\nOtherwise, please make sure the dependencies are installed with your system package manager, or a tool like `pip`. Use of a conda environment or virtualenv is recommended!\n\nThe package can then be installed with:\n\n```python setup.py install```\n\n\n## URL\n\nThe URL for the WebMUST instance in use can be specified when instantiating the Must class. If none is given, a default URL is used. For example:\n\n```python\nmust = mustlink.Must(url='https://mustinstance.com/mustlink')\n```\n\n## Authentication\n\nAccess to WebMUST needs authentication. This is controlled by a config file which can be pointed to by the `config_file` parameter when instantiating the Must class, for example:\n\n```python\nmust = mustlink.Must(config_file='path_to/config.file')\n```\n\nIf nothing is specified, a file `mustlink.yml` is looked for in paths pointed to by the environment variables `APPDATA`, `XDG_CONFIG_HOME` or in the `.config` folder in the user's home directory.\n\nThe configuration file should be in YAML format and contain the username and password as follows:\n\n```yaml\nuser:\n login: \"userone\"\n password: \"blah\"\n```\n\n## Example\n\nThe Jupyter notebook included with this repository shows an example of how to use the code. Note that not all API functions are wrapped by this library, but only those that are commonly used. To view the notebook, click [here](https://nbviewer.jupyter.org/github/msbentley/mustlink/blob/master/mustlink_example.ipynb).\n",
"bugtrack_url": null,
"license": "",
"summary": "A python wrapper for the ESA mustlink API",
"version": "0.3.2",
"split_keywords": [
"telemetry",
"must",
"esa"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c02f8359a077aa7f043f99b7e80e9b3679acbd2f93151ccf8a1778af568dab1c",
"md5": "8265431e2a71dcdd6d4d2f595f822682",
"sha256": "b17e967c8c414f2b924f90c576feeeb32e8c39058e50a45dc6bbbb5f26dd50a9"
},
"downloads": -1,
"filename": "mustlink-0.3.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8265431e2a71dcdd6d4d2f595f822682",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.0",
"size": 10206,
"upload_time": "2023-04-12T12:29:08",
"upload_time_iso_8601": "2023-04-12T12:29:08.842159Z",
"url": "https://files.pythonhosted.org/packages/c0/2f/8359a077aa7f043f99b7e80e9b3679acbd2f93151ccf8a1778af568dab1c/mustlink-0.3.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fb8f10d104011eb494f8d9c937addbf891f0ea6acdab56c41353b90b41270a33",
"md5": "daf71edb311d15c37f1993439c7cb73e",
"sha256": "4a08ad583b18d3f0741547b6b26f860ce84bf518d98adc7771d35b1b9dea79de"
},
"downloads": -1,
"filename": "mustlink-0.3.2.tar.gz",
"has_sig": false,
"md5_digest": "daf71edb311d15c37f1993439c7cb73e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.0",
"size": 10815,
"upload_time": "2023-04-12T12:29:10",
"upload_time_iso_8601": "2023-04-12T12:29:10.155854Z",
"url": "https://files.pythonhosted.org/packages/fb/8f/10d104011eb494f8d9c937addbf891f0ea6acdab56c41353b90b41270a33/mustlink-0.3.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-12 12:29:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "msbentley",
"github_project": "mustlink",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mustlink"
}
JSON
