[Open in Visual Studio Code](https://github1s.com/PS1607/mbox-to-json)
<div id="top"></div>
<!--
*** Thanks for checking out the Best-README-Template. If you have a suggestion
*** that would make this better, please fork the repo and create a pull request
*** or simply open an issue with the tag "enhancement".
*** Don't forget to give the project a star!
*** Thanks again! Now go create something AMAZING! :D
-->
<!-- PROJECT SHIELDS -->
<!--
*** I'm using markdown "reference style" links for readability.
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
*** See the bottom of this document for the declaration of the reference variables
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
-->
<sup>Prakhar Sharma - </sup>[![LinkedIn][linkedin-shield]][linkedin-url]<br>
<sup>Adrita Bhattacharya - </sup>[![LinkedIn][linkedin-shield]][linkedin-url2]
<h1 align="center">MBOX to JSON</h1>
<p align="center">
A command line tool to convert MBOX file to JSON.
<br />
<a href="https://github.com/PS1607/mbox-to-json"><strong>Explore the docs » (Currently NA)</strong></a>
<br />
<br />
<a href="https://github.com/PS1607/mbox-to-json/">View Demo</a>
·
<a href="https://github.com/PS1607/mbox-to-json/issues">Report Bug</a>
·
<a href="https://github.com/PS1607/mbox-to-json/issues">Request Feature</a>
</p>
</div>
<!-- TABLE OF CONTENTS -->
<details open>
<summary>Table of Contents</summary>
<ol>
<li>
<a href="#about-the-project">About The Project</a>
<ul>
<li><a href="#built-with">Built With</a></li>
</ul>
</li>
<li>
<a href="#getting-started">Getting Started</a>
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#installation">Installation</a></li>
</ul>
</li>
<li><a href="#usage">Usage</a></li>
<li><a href="#roadmap">Roadmap</a></li>
<li><a href="#license">License</a></li>
<li><a href="#contact">Contact</a></li>
</ol>
</details>
<br>
<!-- ABOUT THE PROJECT -->
## About The Project
A small package that converts MBOX files to JSON. Also includes functionality to extract attachments.
<p align="right">(<a href="#top">back to top</a>)</p>
### Built With
- [Python](https://www.python.org/)
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- GETTING STARTED -->
## Getting Started
There are 2 ways to install this tool.<br><br>
### Prerequisites
Make sure you upgrade `pip` before moving on.<br>
All the required dependencies are in [`requirements.txt`](https://github.com/PS1607/mbox-to-json/blob/main/requirements.txt) which would be installed at the time of running the setup.
```sh
pip install --upgrade pip
```
<br>
### 1. Install from [PyPI](https://pypi.org/project/mbox-to-json/)
```sh
pip install mbox-to-json
```
<br>
### 2. Install from GitHub
1. Download the repository as zip. Unzip.
2. `cd` to the repository folder
3. Run this command
```sh
pip install .
```
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- USAGE EXAMPLES -->
## Usage
- Help Function
```sh
mbox-to-json -h
```
- Most basic conversion from MBOX to JSON. Just provide the file path. Output JSON file would be in the same location as the input file.
```sh
mbox-to-json /Users/prakhar/downloads/random_file.mbox
```
- Use **`-a`** flag to extract attachments. The files would be available in **`input_file_directory/attachments`**
```sh
mbox-to-json /Users/prakhar/downloads/random_file.mbox -a
```
- Use **`-c`** flag to convert to CSV insted of JSON. Output CSV file would be in the same location as the input file.
```sh
mbox-to-json /Users/prakhar/downloads/random_file.mbox -c
```
- Use **`-o`** to specify the output file location. Make sure to provide the file name too, with the extension JSON (or CSV)
```sh
mbox-to-json /Users/prakhar/downloads/random_file.mbox -o /Users/prakhar/downloads/random_output.json
```
_For more examples, please refer to the [Documentation](https://pypi.org/project/mbox-to-json/)_
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- ROADMAP -->
## Roadmap
- [ ] TBA
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- LICENSE -->
## License
Distributed under the MIT License. See [`LICENSE.txt`](https://github.com/PS1607/mbox-to-json/blob/main/LICENSE.txt) for more information.
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- CONTACT -->
## Contact
LinkedIn - [Prakhar Sharma](https://www.linkedin.com/in/prakhar-sharma-2020/), [Adrita Bhattacharya](https://www.linkedin.com/in/adrita-bhattacharya-6bab581a9/)
Github - [PS1607](https://github.com/PS1607), [adritabhattacharya](https://github.com/adritabhattacharya)
Google Developer - [PS1607](https://g.dev/ps1607)
<p align="right">(<a href="#top">back to top</a>)</p>
<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/dyte-submissions/dyte-vit-2022-PS1607.svg?style=for-the-badge
[contributors-url]: https://github.com/PS1607/mbox-to-json/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/dyte-submissions/dyte-vit-2022-PS1607.svg?style=for-the-badge
[forks-url]: https://github.com/PS1607/mbox-to-json/network/members
[stars-shield]: https://img.shields.io/github/stars/dyte-submissions/dyte-vit-2022-PS1607.svg?style=for-the-badge
[stars-url]: https://github.com/PS1607/mbox-to-json/stargazers
[issues-shield]: https://img.shields.io/github/issues/dyte-submissions/dyte-vit-2022-PS1607.svg?style=for-the-badge
[issues-url]: https://github.com/PS1607/mbox-to-json/issues
[license-shield]: https://img.shields.io/github/license/dyte-submissions/dyte-vit-2022-PS1607.svg?style=for-the-badge
[license-url]: https://github.com/PS1607/mbox-to-json/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://www.linkedin.com/in/prakhar-sharma-2020/
[linkedin-url2]: https://www.linkedin.com/in/adrita-bhattacharya-6bab581a9/
Raw data
{
"_id": null,
"home_page": "https://github.com/PS1607/mbox-to-json",
"name": "mbox-to-json",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "MBOX to JSON Converter",
"author": "Prakhar Sharma, Adrita Bhattacharya",
"author_email": "prakharsharma1607@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/01/50/63de31e39cade6dc74e4a44d4339a8573e28481a177aee2f62df21775088/mbox_to_json-1.0.5.tar.gz",
"platform": null,
"description": "[Open in Visual Studio Code](https://github1s.com/PS1607/mbox-to-json)\n\n<div id=\"top\"></div>\n<!--\n*** Thanks for checking out the Best-README-Template. If you have a suggestion\n*** that would make this better, please fork the repo and create a pull request\n*** or simply open an issue with the tag \"enhancement\".\n*** Don't forget to give the project a star!\n*** Thanks again! Now go create something AMAZING! :D\n-->\n\n<!-- PROJECT SHIELDS -->\n<!--\n*** I'm using markdown \"reference style\" links for readability.\n*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).\n*** See the bottom of this document for the declaration of the reference variables\n*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.\n*** https://www.markdownguide.org/basic-syntax/#reference-style-links\n-->\n\n<sup>Prakhar Sharma - </sup>[![LinkedIn][linkedin-shield]][linkedin-url]<br>\n<sup>Adrita Bhattacharya - </sup>[![LinkedIn][linkedin-shield]][linkedin-url2]\n\n<h1 align=\"center\">MBOX to JSON</h1>\n\n <p align=\"center\">\n A command line tool to convert MBOX file to JSON.\n <br />\n <a href=\"https://github.com/PS1607/mbox-to-json\"><strong>Explore the docs \u00bb (Currently NA)</strong></a>\n <br />\n <br />\n <a href=\"https://github.com/PS1607/mbox-to-json/\">View Demo</a>\n \u00b7 \n <a href=\"https://github.com/PS1607/mbox-to-json/issues\">Report Bug</a>\n \u00b7 \n <a href=\"https://github.com/PS1607/mbox-to-json/issues\">Request Feature</a>\n </p>\n</div>\n\n<!-- TABLE OF CONTENTS -->\n<details open>\n <summary>Table of Contents</summary>\n <ol>\n <li>\n <a href=\"#about-the-project\">About The Project</a>\n <ul>\n <li><a href=\"#built-with\">Built With</a></li>\n </ul>\n </li>\n <li>\n <a href=\"#getting-started\">Getting Started</a>\n <ul>\n <li><a href=\"#prerequisites\">Prerequisites</a></li>\n <li><a href=\"#installation\">Installation</a></li>\n </ul>\n </li>\n <li><a href=\"#usage\">Usage</a></li>\n <li><a href=\"#roadmap\">Roadmap</a></li>\n <li><a href=\"#license\">License</a></li>\n <li><a href=\"#contact\">Contact</a></li>\n </ol>\n</details>\n\n<br>\n<!-- ABOUT THE PROJECT -->\n\n## About The Project\n\nA small package that converts MBOX files to JSON. Also includes functionality to extract attachments.\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n\n### Built With\n\n- [Python](https://www.python.org/)\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n\n<!-- GETTING STARTED -->\n\n## Getting Started\n\nThere are 2 ways to install this tool.<br><br>\n\n### Prerequisites\n\nMake sure you upgrade `pip` before moving on.<br>\nAll the required dependencies are in [`requirements.txt`](https://github.com/PS1607/mbox-to-json/blob/main/requirements.txt) which would be installed at the time of running the setup.\n\n```sh\npip install --upgrade pip\n```\n\n<br>\n\n### 1. Install from [PyPI](https://pypi.org/project/mbox-to-json/)\n\n```sh\npip install mbox-to-json\n```\n\n<br>\n\n### 2. Install from GitHub\n\n1. Download the repository as zip. Unzip.\n2. `cd` to the repository folder\n3. Run this command\n\n ```sh\n pip install .\n ```\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n\n<!-- USAGE EXAMPLES -->\n\n## Usage\n\n- Help Function\n\n ```sh\n mbox-to-json -h\n ```\n\n- Most basic conversion from MBOX to JSON. Just provide the file path. Output JSON file would be in the same location as the input file.\n\n ```sh\n mbox-to-json /Users/prakhar/downloads/random_file.mbox\n ```\n\n- Use **`-a`** flag to extract attachments. The files would be available in **`input_file_directory/attachments`**\n\n ```sh\n mbox-to-json /Users/prakhar/downloads/random_file.mbox -a\n ```\n\n- Use **`-c`** flag to convert to CSV insted of JSON. Output CSV file would be in the same location as the input file.\n\n ```sh\n mbox-to-json /Users/prakhar/downloads/random_file.mbox -c\n ```\n\n- Use **`-o`** to specify the output file location. Make sure to provide the file name too, with the extension JSON (or CSV)\n ```sh\n mbox-to-json /Users/prakhar/downloads/random_file.mbox -o /Users/prakhar/downloads/random_output.json\n ```\n\n_For more examples, please refer to the [Documentation](https://pypi.org/project/mbox-to-json/)_\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n\n<!-- ROADMAP -->\n\n## Roadmap\n\n- [ ] TBA\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n\n<!-- LICENSE -->\n\n## License\n\nDistributed under the MIT License. See [`LICENSE.txt`](https://github.com/PS1607/mbox-to-json/blob/main/LICENSE.txt) for more information.\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n\n<!-- CONTACT -->\n\n## Contact\n\nLinkedIn - [Prakhar Sharma](https://www.linkedin.com/in/prakhar-sharma-2020/), [Adrita Bhattacharya](https://www.linkedin.com/in/adrita-bhattacharya-6bab581a9/)\n\nGithub - [PS1607](https://github.com/PS1607), [adritabhattacharya](https://github.com/adritabhattacharya)\n\nGoogle Developer - [PS1607](https://g.dev/ps1607)\n\n<p align=\"right\">(<a href=\"#top\">back to top</a>)</p>\n\n<!-- MARKDOWN LINKS & IMAGES -->\n<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->\n\n[contributors-shield]: https://img.shields.io/github/contributors/dyte-submissions/dyte-vit-2022-PS1607.svg?style=for-the-badge\n[contributors-url]: https://github.com/PS1607/mbox-to-json/graphs/contributors\n[forks-shield]: https://img.shields.io/github/forks/dyte-submissions/dyte-vit-2022-PS1607.svg?style=for-the-badge\n[forks-url]: https://github.com/PS1607/mbox-to-json/network/members\n[stars-shield]: https://img.shields.io/github/stars/dyte-submissions/dyte-vit-2022-PS1607.svg?style=for-the-badge\n[stars-url]: https://github.com/PS1607/mbox-to-json/stargazers\n[issues-shield]: https://img.shields.io/github/issues/dyte-submissions/dyte-vit-2022-PS1607.svg?style=for-the-badge\n[issues-url]: https://github.com/PS1607/mbox-to-json/issues\n[license-shield]: https://img.shields.io/github/license/dyte-submissions/dyte-vit-2022-PS1607.svg?style=for-the-badge\n[license-url]: https://github.com/PS1607/mbox-to-json/blob/master/LICENSE.txt\n[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555\n[linkedin-url]: https://www.linkedin.com/in/prakhar-sharma-2020/\n[linkedin-url2]: https://www.linkedin.com/in/adrita-bhattacharya-6bab581a9/\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "MBOX to JSON Converter",
"version": "1.0.5",
"project_urls": {
"Homepage": "https://github.com/PS1607/mbox-to-json"
},
"split_keywords": [
"mbox",
"to",
"json",
"converter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "79e74fb0f6bdfd3670156e2e57ff435b67fc9f26a6463fe4ee4cce7eebd14455",
"md5": "7d14bb4fffbe8b159493c4ce6ce658a6",
"sha256": "4cb229385fd53f269258f854fe720a3b8cc0c0000e14e7b60f30dba765218483"
},
"downloads": -1,
"filename": "mbox_to_json-1.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7d14bb4fffbe8b159493c4ce6ce658a6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8966,
"upload_time": "2024-11-09T14:31:59",
"upload_time_iso_8601": "2024-11-09T14:31:59.103838Z",
"url": "https://files.pythonhosted.org/packages/79/e7/4fb0f6bdfd3670156e2e57ff435b67fc9f26a6463fe4ee4cce7eebd14455/mbox_to_json-1.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "015063de31e39cade6dc74e4a44d4339a8573e28481a177aee2f62df21775088",
"md5": "7e75fa9ff9a3eedcf8e0c887c25d5f4b",
"sha256": "816a96cdf12ce25bca2b55229e3a38f50638edf58a3f11ccc3da5b425e9c3bf9"
},
"downloads": -1,
"filename": "mbox_to_json-1.0.5.tar.gz",
"has_sig": false,
"md5_digest": "7e75fa9ff9a3eedcf8e0c887c25d5f4b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8823,
"upload_time": "2024-11-09T14:32:00",
"upload_time_iso_8601": "2024-11-09T14:32:00.676751Z",
"url": "https://files.pythonhosted.org/packages/01/50/63de31e39cade6dc74e4a44d4339a8573e28481a177aee2f62df21775088/mbox_to_json-1.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-09 14:32:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PS1607",
"github_project": "mbox-to-json",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "mbox-to-json"
}
JSON
