# Slurm-mongo
[![Python Package](https://github.com/neelravi/slurm-mongo/actions/workflows/python-publish.yml/badge.svg?branch=main)](https://github.com/neelravi/slurm-mongo/actions/workflows/python-publish.yml)
[![PyPI version](https://badge.fury.io/py/slurm-mongo.svg)](https://badge.fury.io/py/slurm-mongo)
Slurm-Mongo is a Python package that downloads SLURM usage data from a supercomputer and uploads it to MongoDB.
## Installation
You can install Slurm-Mongo using pip:
```bash
pip install slurm-mongo
```
## Usage
You can use Slurm-Mongo by running the `slurm_mongo` command followed by the start date, end date, and supercomputer host name in user@hostname format:
```bash
slurm_mongo start_date end_date supercomputer_host_name
```
## Example
```bash
slurm_mongo '2017-01-01' '2017-01-02' 'shinde@snellius.surf.nl'
```
By default, Slurm-Mongo will connect to a MongoDB instance running on `localhost:27017` and will store the data in a database called "Snellius" and a collection called "Usage". You can customize the MongoDB connection and database/collection names by using the optional `--connection`, `--port`, `--database`, and `--collection` flags:
```bash
slurm_mongo start_date end_date supercomputer_host_name --connection mongo.example.com --port 12345 --database MySlurm --collection MyUsage
```
## License
Slurm-Mongo is released under the MIT License. See LICENSE for more information.
## Issues
If you encounter any issues with Slurm-Mongo, please report them on the GitHub issue tracker.
## Contact
Contact the author Dr. Ravindra Shinde at r.l.shinde@utwente.nl
Raw data
{
"_id": null,
"home_page": "https://github.com/neelravi/slurm-mongo",
"name": "slurm-mongo",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "slurm usage uploader mongodb",
"author": "Ravindra Shinde",
"author_email": "r.l.shinde@utwente.nl",
"download_url": "https://files.pythonhosted.org/packages/a3/cb/f939804728ed1cb97aef49ee54670b59db25c79b3e21ef6f903c121e681c/slurm_mongo-1.0.2.tar.gz",
"platform": null,
"description": "# Slurm-mongo\n[![Python Package](https://github.com/neelravi/slurm-mongo/actions/workflows/python-publish.yml/badge.svg?branch=main)](https://github.com/neelravi/slurm-mongo/actions/workflows/python-publish.yml)\n\n[![PyPI version](https://badge.fury.io/py/slurm-mongo.svg)](https://badge.fury.io/py/slurm-mongo)\n\n\nSlurm-Mongo is a Python package that downloads SLURM usage data from a supercomputer and uploads it to MongoDB.\n\n## Installation\n\nYou can install Slurm-Mongo using pip:\n\n```bash\npip install slurm-mongo\n```\n\n## Usage\n\nYou can use Slurm-Mongo by running the `slurm_mongo` command followed by the start date, end date, and supercomputer host name in user@hostname format:\n\n```bash\nslurm_mongo start_date end_date supercomputer_host_name\n```\n\n## Example\n\n```bash\nslurm_mongo '2017-01-01' '2017-01-02' 'shinde@snellius.surf.nl'\n```\n\nBy default, Slurm-Mongo will connect to a MongoDB instance running on `localhost:27017` and will store the data in a database called \"Snellius\" and a collection called \"Usage\". You can customize the MongoDB connection and database/collection names by using the optional `--connection`, `--port`, `--database`, and `--collection` flags:\n\n```bash\nslurm_mongo start_date end_date supercomputer_host_name --connection mongo.example.com --port 12345 --database MySlurm --collection MyUsage\n```\n\n## License\n\nSlurm-Mongo is released under the MIT License. See LICENSE for more information.\n\n## Issues\n\nIf you encounter any issues with Slurm-Mongo, please report them on the GitHub issue tracker.\n\n## Contact\n\nContact the author Dr. Ravindra Shinde at r.l.shinde@utwente.nl\n",
"bugtrack_url": null,
"license": "",
"summary": "A package to download slurm usage from a supercomputer and upload it to MongoDB",
"version": "1.0.2",
"split_keywords": [
"slurm",
"usage",
"uploader",
"mongodb"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "519ddb38c39b927720f0dac52d26bb5b6f427998bb8cb51b9b0c475cd7132c13",
"md5": "f35b3c6e2bf1d7c7ce56483eb24f7de0",
"sha256": "cfcdb5027d8a6297d02b91a7a65a08d91ce1479ea2549193fa4bfa56e74be364"
},
"downloads": -1,
"filename": "slurm_mongo-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f35b3c6e2bf1d7c7ce56483eb24f7de0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 2250,
"upload_time": "2023-04-17T09:36:37",
"upload_time_iso_8601": "2023-04-17T09:36:37.385240Z",
"url": "https://files.pythonhosted.org/packages/51/9d/db38c39b927720f0dac52d26bb5b6f427998bb8cb51b9b0c475cd7132c13/slurm_mongo-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a3cbf939804728ed1cb97aef49ee54670b59db25c79b3e21ef6f903c121e681c",
"md5": "eeacadb93a67cadf0e0dc95ba9d31091",
"sha256": "c81d8a88f4bfcfab359fe71e79742c801cf6daec749d620f7fba6d9badaff356"
},
"downloads": -1,
"filename": "slurm_mongo-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "eeacadb93a67cadf0e0dc95ba9d31091",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 2171,
"upload_time": "2023-04-17T09:36:38",
"upload_time_iso_8601": "2023-04-17T09:36:38.354476Z",
"url": "https://files.pythonhosted.org/packages/a3/cb/f939804728ed1cb97aef49ee54670b59db25c79b3e21ef6f903c121e681c/slurm_mongo-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-17 09:36:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "neelravi",
"github_project": "slurm-mongo",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "slurm-mongo"
}