Metadata-Version: 2.1
Name: maryam
Version: 2.2.6.post4
Summary: OWASP Maryam is a modular/optional open-source framework based on OSINT and data gathering.
Home-page: https://github.com/saeeddhqan/Maryam
Author: Saeed Dehqan
Author-email: saeed.dehghan@owasp.org
License: GPL-V3
Description: [![Build Status](https://travis-ci.com/saeeddhqan/maryam.svg?branch=master)](https://travis-ci.com/saeeddhqan/maryam)
        ![Version 2.2.6](https://img.shields.io/badge/Version-2.2.6-green.svg)
        ![GPLv3 License](https://img.shields.io/badge/License-GPLv3-green.svg)
        ![Python 3.8.x](https://img.shields.io/badge/Python-3.8.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
         - OSX
        
        ```bash
        $ pip install maryam
        ```
        
        # 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 the framework modules
        maryam -e show modules
        # Set framework options. It'll save in the workspace.
        maryam -e set proxy ..
        maryam -e set agent ..
        maryam -e set timeout ..
        # Run web API
        maryam -e web api 127.0.0.1 1313
        ```
        
        # Updates
        **Last Updates**
        
         - Add famous_person
         - Speed up the core
         - Add setup.py and change arch
         - Web API: web command
         - Error stack and a better performance for dev
         - Update google and yahoo: new format
        
        
        # 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 current search engines to write a new module.
        The best help to write a new module is by checking the current modules.
        
        ## Roadmap
        
         - Write a complete metacrawler engine based on OSINT by using the current search engines
         - Add clustering algorithms
         - 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).
        
Keywords: OWASP,OSINT,search-engine,social-networks,Maryam
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.8
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Environment :: Console
Description-Content-Type: text/markdown
