# Mongo Analyser
<img src="assets/logo_v1.png" align="right" width="25%"/>
[![Tests](https://github.com/habedi/mongo-analyser/actions/workflows/tests.yml/badge.svg)](https://github.com/habedi/mongo-analyser/actions/workflows/tests.yml)
[![codecov](https://codecov.io/gh/habedi/mongo-analyser/graph/badge.svg?token=HOTAZKP3V7)](https://codecov.io/gh/habedi/mongo-analyser)
[![CodeFactor](https://www.codefactor.io/repository/github/habedi/mongo-analyser/badge)](https://www.codefactor.io/repository/github/habedi/mongo-analyser)
[![PyPI version](https://badge.fury.io/py/mongo-analyser.svg)](https://badge.fury.io/py/mongo-analyser)
[![Pip downloads](https://img.shields.io/pypi/dm/mongo-analyser.svg)](https://pypi.org/project/mongo-analyser)
[![Python version](https://img.shields.io/badge/Python-%3E=3.9-blue)](https://github.com/habedi/mongo-analyser)
[![Documentation](https://img.shields.io/badge/docs-latest-blue)](https://github.com/habedi/mongo-analyser/blob/main/docs/index.md)
[![License](https://img.shields.io/badge/license-MIT-blue)](https://github.com/habedi/mongo-analyser/blob/main/LICENSE)
Mongo Analyser is a tool that helps you analyse and infer a MongoDB collection's structure. It can help you extract the
schema of a collection, find the data types of the fields and also export data from the collection based on the
schema it found.
Mongo Analyser can be used as a command-line tool or as a Python library.
## Installation
You can install Mongo Analyser using `pip` (mainly to use it as a library):
```bash
pip install mongo-analyser
```
You can also install it as a standalone executable using `pipx` or `uv`:
```bash
pipx install mongo-analyser
```
```bash
uv tool install mongo-analyser
```
After the installation is complete, you can use the `mongo-analyser` command in your terminal.
See the [documentation](https://github.com/habedi/mongo-analyser/blob/main/docs/index.md) for more information and
examples.
Raw data
{
"_id": null,
"home_page": "https://github.com/habedi/mongo-analyser",
"name": "mongo-analyser",
"maintainer": "Hassan Abedi",
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": "hassan.abedi.t@gmail.com",
"keywords": "mongodb, python, nosql, command-line tool, json",
"author": "Hassan Abedi",
"author_email": "hassan.abedi.t@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/0f/aa/8c822c18a2d7fc9378f8e201dbe6ce8d7834a60ab99f924facb40485afe0/mongo_analyser-0.1.4.tar.gz",
"platform": null,
"description": "# Mongo Analyser\n\n<img src=\"assets/logo_v1.png\" align=\"right\" width=\"25%\"/>\n\n[![Tests](https://github.com/habedi/mongo-analyser/actions/workflows/tests.yml/badge.svg)](https://github.com/habedi/mongo-analyser/actions/workflows/tests.yml)\n[![codecov](https://codecov.io/gh/habedi/mongo-analyser/graph/badge.svg?token=HOTAZKP3V7)](https://codecov.io/gh/habedi/mongo-analyser)\n[![CodeFactor](https://www.codefactor.io/repository/github/habedi/mongo-analyser/badge)](https://www.codefactor.io/repository/github/habedi/mongo-analyser)\n[![PyPI version](https://badge.fury.io/py/mongo-analyser.svg)](https://badge.fury.io/py/mongo-analyser)\n[![Pip downloads](https://img.shields.io/pypi/dm/mongo-analyser.svg)](https://pypi.org/project/mongo-analyser)\n[![Python version](https://img.shields.io/badge/Python-%3E=3.9-blue)](https://github.com/habedi/mongo-analyser)\n[![Documentation](https://img.shields.io/badge/docs-latest-blue)](https://github.com/habedi/mongo-analyser/blob/main/docs/index.md)\n[![License](https://img.shields.io/badge/license-MIT-blue)](https://github.com/habedi/mongo-analyser/blob/main/LICENSE)\n\nMongo Analyser is a tool that helps you analyse and infer a MongoDB collection's structure. It can help you extract the\nschema of a collection, find the data types of the fields and also export data from the collection based on the\nschema it found.\n\nMongo Analyser can be used as a command-line tool or as a Python library.\n\n## Installation\n\nYou can install Mongo Analyser using `pip` (mainly to use it as a library):\n\n```bash\npip install mongo-analyser\n```\n\nYou can also install it as a standalone executable using `pipx` or `uv`:\n\n```bash\npipx install mongo-analyser\n```\n\n```bash\nuv tool install mongo-analyser\n```\n\nAfter the installation is complete, you can use the `mongo-analyser` command in your terminal.\n\nSee the [documentation](https://github.com/habedi/mongo-analyser/blob/main/docs/index.md) for more information and\nexamples.\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A minimalistic tool for analysing and extracting the schema of a MongoDB collection.",
"version": "0.1.4",
"project_urls": {
"Documentation": "https://github.com/habedi/mongo-analyser/blob/main/docs/index.md",
"Homepage": "https://github.com/habedi/mongo-analyser",
"Repository": "https://github.com/habedi/mongo-analyser"
},
"split_keywords": [
"mongodb",
" python",
" nosql",
" command-line tool",
" json"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f5aa40fa4b886578459588fd4fcb943e1f0389c0380cc15de0400d62787715ca",
"md5": "c3979ea7a97fe167397cfcb539e4fa9f",
"sha256": "7e62553f88e0bd3044fb016a9889ca502eee3a62035b6414e330db4a130ae3b9"
},
"downloads": -1,
"filename": "mongo_analyser-0.1.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c3979ea7a97fe167397cfcb539e4fa9f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 12597,
"upload_time": "2024-10-21T08:58:39",
"upload_time_iso_8601": "2024-10-21T08:58:39.235519Z",
"url": "https://files.pythonhosted.org/packages/f5/aa/40fa4b886578459588fd4fcb943e1f0389c0380cc15de0400d62787715ca/mongo_analyser-0.1.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0faa8c822c18a2d7fc9378f8e201dbe6ce8d7834a60ab99f924facb40485afe0",
"md5": "2e9715ed855c82daadafa086877631ca",
"sha256": "675984edb1d03740171449644492d4dbadefcda2098d027b2de8296a0ee36d20"
},
"downloads": -1,
"filename": "mongo_analyser-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "2e9715ed855c82daadafa086877631ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 9934,
"upload_time": "2024-10-21T08:58:40",
"upload_time_iso_8601": "2024-10-21T08:58:40.135464Z",
"url": "https://files.pythonhosted.org/packages/0f/aa/8c822c18a2d7fc9378f8e201dbe6ce8d7834a60ab99f924facb40485afe0/mongo_analyser-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-21 08:58:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "habedi",
"github_project": "mongo-analyser",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"lcname": "mongo-analyser"
}