Metadata-Version: 2.1
Name: mongo-analyser
Version: 0.1.2
Summary: A minimalistic tool for analysing and extracting the schema of a MongoDB collection.
Home-page: https://github.com/habedi/mongo-analyser
License: MIT
Keywords: mongodb,python,nosql,command-line tool,json
Author: Hassan Abedi
Author-email: hassan.abedi.t@gmail.com
Maintainer: Hassan Abedi
Maintainer-email: hassan.abedi.t@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: mypy (>=1.11.1,<2.0.0)
Requires-Dist: poetry-dynamic-versioning (>=1.4.0,<2.0.0)
Requires-Dist: pylint (>=3.0.3,<4.0.0)
Requires-Dist: pymongo (>=4.10.1,<5.0.0)
Requires-Dist: pytest (>=8.0.1,<9.0.0)
Requires-Dist: pytest-cov (>=5.0.0,<6.0.0)
Requires-Dist: pytest-mock (>=3.14.0,<4.0.0)
Requires-Dist: pytz (>=2024.2,<2025.0)
Requires-Dist: ruff (>=0.7.0,<0.8.0)
Project-URL: Documentation, https://github.com/habedi/mongo-analyser/blob/main/docs/index.md
Project-URL: Repository, https://github.com/habedi/mongo-analyser
Description-Content-Type: text/markdown

# Mongo Analyser

<img src="https://github.com/habedi/mongo-analyser/blob/main/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)
[![PyPI version](https://badge.fury.io/py/mongo-analyser.svg)](https://badge.fury.io/py/mongo-analyser)
[![License](https://img.shields.io/github/license/habedi/mongo-analyser)](https://github.com/habedi/mongo-analyser/blob/main/LICENSE)
[![Python version](https://img.shields.io/badge/Python-%3E=3.9-blue)](https://github.com/habedi/mongo-analyser)
[![Pip downloads](https://img.shields.io/pypi/dm/mongo-analyser.svg)](https://pypi.org/project/mongo-analyser)
[![Documentation](https://img.shields.io/badge/docs-latest-green)](https://github.com/habedi/mongo-analyser/blob/main/docs/index.md)
[![CodeFactor](https://www.codefactor.io/repository/github/habedi/mongo-analyser/badge)](https://www.codefactor.io/repository/github/habedi/mongo-analyser)

Mongo Analyser is a tool that helps you to analyse the structure of a MongoDB collection. It can help you extract the
schema of a collection, find the data types of the fields, and also extract sample data from the collection based on the
schema.

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:

```bash
pipx install mongo-analyser
```

After installing it using pipx, you can run it from the command line:

```bash
mongo-analyser <command> [<args>]
```

See the [documentation](https://github.com/habedi/mongo-analyser/blob/main/docs/index.md) for more information and
examples.

