[![Build Status](https://app.travis-ci.com/saeeddhqan/Maryam.svg?branch=master)](https://app.travis-ci.com/github/saeeddhqan/Maryam)
![Version 2.5.2](https://img.shields.io/badge/Version-2.5.2-green.svg)
![GPLv3 License](https://img.shields.io/badge/License-GPLv3-green.svg)
![Python 3.10.x](https://img.shields.io/badge/Python-3.10.x-green.svg)
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/4577/badge)](https://bestpractices.coreinfrastructure.org/projects/4577)
# OWASP Maryam
OWASP Maryam is a modular open-source framework based on OSINT and data gathering. It is designed to provide a robust environment to harvest data from open sources and search engines quickly and thoroughly.
# Installation
### Supported OS
- Linux
- FreeBSD
- Darwin
- OSX
```bash
$ pip install maryam
```
Alternatively, you can install the latest version with the following command (Recommended):
```bash
pip install git+https://github.com/saeeddhqan/maryam.git
```
# Usage
```bash
# Using dns_search. --max means all of resources. --api shows the results as json.
# .. -t means use multi-threading.
maryam -e dns_search -d ibm.com -t 5 --max --api --form
# Using youtube. -q means query
maryam -e youtube -q "<QUERY>"
maryam -e google -q "<QUERY>"
maryam -e dnsbrute -d domain.tld
# Show framework modules
maryam -e show modules
# Set framework options.
maryam -e set proxy ..
maryam -e set agent ..
maryam -e set timeout ..
# Run web API
maryam -e web api 127.0.0.1 1313
```
# Latest Updates
- Added image_search module
- Clustering, Meta Search Engine, Dark-Web Search
- Iris: the first beta version
- Added famous_person
- Core speedup optimizations
- Added setup.py
# Contribution
Contributes are welcome! Here is a start guide: [Development Guide](https://github.com/saeeddhqan/maryam/wiki/Development-Guide)
You can add a new search engine to the util classes or use the current search engines to write a new module.
The best help to write a new module is checking the current modules.
# Roadmap
- Improving Iris page ranking
- Write a complete metacrawler engine based on OSINT by using the current search engines
- Add clustering algorithms: Done
- Web user interface
# Links
### [OWASP](https://owasp.org/www-project-maryam/)
### [Wiki](https://github.com/saeeddhqan/maryam/wiki)
### [Install](https://github.com/saeeddhqan/maryam/wiki#install)
### [Modules Guide](https://github.com/saeeddhqan/maryam/wiki/modules)
### [Development Guide](https://github.com/saeeddhqan/maryam/wiki/Development-Guide)
To report bugs, requests, or any other issues please [create an issue](https://github.com/saeeddhqan/maryam/issues).
Raw data
{
"_id": null,
"home_page": "https://github.com/saeeddhqan/Maryam",
"name": "maryam",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "OWASP,OSINT,search-engine,social-networks,Maryam",
"author": "Saeed Dehqan",
"author_email": "saeed.dehghan@owasp.org",
"download_url": "https://files.pythonhosted.org/packages/e0/84/cfefee4fe010d5dfab7af28afae2f2ba53554496385c0ee4ea2f69f5e828/maryam-2.5.2.post2.tar.gz",
"platform": null,
"description": "[![Build Status](https://app.travis-ci.com/saeeddhqan/Maryam.svg?branch=master)](https://app.travis-ci.com/github/saeeddhqan/Maryam)\n![Version 2.5.2](https://img.shields.io/badge/Version-2.5.2-green.svg)\n![GPLv3 License](https://img.shields.io/badge/License-GPLv3-green.svg)\n![Python 3.10.x](https://img.shields.io/badge/Python-3.10.x-green.svg)\n[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/4577/badge)](https://bestpractices.coreinfrastructure.org/projects/4577)\n\n# OWASP Maryam\n\nOWASP Maryam is a modular open-source framework based on OSINT and data gathering. It is designed to provide a robust environment to harvest data from open sources and search engines quickly and thoroughly.\n\n# Installation\n\n### Supported OS\n - Linux\n - FreeBSD\n - Darwin\n - OSX\n\n```bash\n$ pip install maryam\n```\nAlternatively, you can install the latest version with the following command (Recommended):\n```bash\npip install git+https://github.com/saeeddhqan/maryam.git\n```\n\n# Usage\n\n```bash\n# Using dns_search. --max means all of resources. --api shows the results as json.\n# .. -t means use multi-threading.\nmaryam -e dns_search -d ibm.com -t 5 --max --api --form \n# Using youtube. -q means query\nmaryam -e youtube -q \"<QUERY>\"\nmaryam -e google -q \"<QUERY>\"\nmaryam -e dnsbrute -d domain.tld\n# Show framework modules\nmaryam -e show modules\n# Set framework options.\nmaryam -e set proxy ..\nmaryam -e set agent ..\nmaryam -e set timeout ..\n# Run web API\nmaryam -e web api 127.0.0.1 1313\n```\n\n# Latest Updates\n\n - Added image_search module\n - Clustering, Meta Search Engine, Dark-Web Search\n - Iris: the first beta version\n - Added famous_person\n - Core speedup optimizations\n - Added setup.py\n\n\n\n# Contribution\n\nContributes are welcome! Here is a start guide: [Development Guide](https://github.com/saeeddhqan/maryam/wiki/Development-Guide)\nYou can add a new search engine to the util classes or use the current search engines to write a new module.\nThe best help to write a new module is checking the current modules.\n\n# Roadmap\n\n - Improving Iris page ranking\n - Write a complete metacrawler engine based on OSINT by using the current search engines\n - Add clustering algorithms: Done\n - Web user interface\n\n# Links\n### [OWASP](https://owasp.org/www-project-maryam/)\n### [Wiki](https://github.com/saeeddhqan/maryam/wiki)\n### [Install](https://github.com/saeeddhqan/maryam/wiki#install)\n### [Modules Guide](https://github.com/saeeddhqan/maryam/wiki/modules)\n### [Development Guide](https://github.com/saeeddhqan/maryam/wiki/Development-Guide)\n\nTo report bugs, requests, or any other issues please [create an issue](https://github.com/saeeddhqan/maryam/issues).\n",
"bugtrack_url": null,
"license": "GPL-V3",
"summary": "OWASP Maryam is a modular/optional open-source framework based on OSINT and data gathering.",
"version": "2.5.2.post2",
"project_urls": {
"Homepage": "https://github.com/saeeddhqan/Maryam"
},
"split_keywords": [
"owasp",
"osint",
"search-engine",
"social-networks",
"maryam"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e084cfefee4fe010d5dfab7af28afae2f2ba53554496385c0ee4ea2f69f5e828",
"md5": "3a84b52abc4f12286b2a8a4891fa1e11",
"sha256": "9e2eea82fb9ac5c03f6b9b4b197f336076f6f92b415da23387663eea262d4a85"
},
"downloads": -1,
"filename": "maryam-2.5.2.post2.tar.gz",
"has_sig": false,
"md5_digest": "3a84b52abc4f12286b2a8a4891fa1e11",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 269574,
"upload_time": "2023-08-06T09:52:26",
"upload_time_iso_8601": "2023-08-06T09:52:26.407832Z",
"url": "https://files.pythonhosted.org/packages/e0/84/cfefee4fe010d5dfab7af28afae2f2ba53554496385c0ee4ea2f69f5e828/maryam-2.5.2.post2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-06 09:52:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "saeeddhqan",
"github_project": "Maryam",
"travis_ci": true,
"coveralls": false,
"github_actions": false,
"lcname": "maryam"
}