# pyosintleak
pyosintleak is a Python library designed to leverage the capabilities of the osintleak API, streamlining the integration and automation of open-source intelligence (OSINT) operations.
## Installation
You can install pyosintleak using pip:
```bash
pip install pyosintleak
```
Alternatively, you can clone the repository from GitHub:
```bash
git clone https://github.com/osintleak/pyosintleak.git
cd pyosintleak
pip install .
```
## Usage
### Command Line Interface (CLI)
pyosintleak also comes with a command line interface (CLI) tool to interact with the API conveniently.
#### Setting API Key
Before using the CLI tool, you need to set your API key. This key is essential for accessing the osintleak API. You can set or update the API key using the following command:
```bash
osintleak --key <your_api_key>
```
#### CLI Options
- **-q, --query**: Set search query (e.g., `-q osintleak.com`)
- **-r, --result_id**: Fetch recent search by ID (e.g., `-r <ID>`)
- **-t, --type**: Set search type (e.g., `-t url`). Default is 'username'
- **-d, --datasets**: Set datasets (e.g., `-d SL,DB,D2`). Default is ''
- **--ss, --similar**: Enable similar search
- **-p, --page**: Set page number (e.g., `-p 1`). Default is 1
- **--ps, --page_size**: Set page size (e.g., `-p 20`). Default is 20
- **-o, --output**: Specify output file (optional)
- **-s, --silent**: Enable silent mode (optional)
- **--key**: Change API key (optional)
#### Example Usage
```bash
# Set API key
osintleak --key <your_api_key>
# Perform a search
osintleak -q ahmed
# Fetch recent search results by ID
osintleak -r <result_id> -p 2
# Save output to a file
osintleak -q example.com -t url -o output.txt
```
Feel free to explore more options and functionalities by checking the help:
```bash
osintleak --help
```
## Contributing
If you encounter any issues or have suggestions for improvements, please feel free to contribute by opening an issue or submitting a pull request on [GitHub](https://github.com/osintleak/pyosintleak). Your feedback is highly appreciated!
Raw data
{
"_id": null,
"home_page": "https://github.com/osintleak/pyosintleak",
"name": "pyosintleak",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3",
"maintainer_email": null,
"keywords": "osintleak, osint, leak, breach, search, ol, pentesting",
"author": "OsintLeak",
"author_email": "help@osintleak.com",
"download_url": "https://files.pythonhosted.org/packages/64/95/b4a8eab15d2e007209280c7d4c8273249537da8124d9e9c6abb7dd567a76/pyosintleak-1.0.1.tar.gz",
"platform": null,
"description": "# pyosintleak\n\npyosintleak is a Python library designed to leverage the capabilities of the osintleak API, streamlining the integration and automation of open-source intelligence (OSINT) operations.\n\n## Installation\n\nYou can install pyosintleak using pip:\n\n```bash\npip install pyosintleak\n```\n\nAlternatively, you can clone the repository from GitHub:\n\n```bash\ngit clone https://github.com/osintleak/pyosintleak.git\ncd pyosintleak\npip install .\n```\n\n## Usage\n\n### Command Line Interface (CLI)\n\npyosintleak also comes with a command line interface (CLI) tool to interact with the API conveniently.\n\n#### Setting API Key\n\nBefore using the CLI tool, you need to set your API key. This key is essential for accessing the osintleak API. You can set or update the API key using the following command:\n\n```bash\nosintleak --key <your_api_key>\n```\n\n#### CLI Options\n\n- **-q, --query**: Set search query (e.g., `-q osintleak.com`)\n- **-r, --result_id**: Fetch recent search by ID (e.g., `-r <ID>`)\n- **-t, --type**: Set search type (e.g., `-t url`). Default is 'username'\n- **-d, --datasets**: Set datasets (e.g., `-d SL,DB,D2`). Default is ''\n- **--ss, --similar**: Enable similar search\n- **-p, --page**: Set page number (e.g., `-p 1`). Default is 1\n- **--ps, --page_size**: Set page size (e.g., `-p 20`). Default is 20\n- **-o, --output**: Specify output file (optional)\n- **-s, --silent**: Enable silent mode (optional)\n- **--key**: Change API key (optional)\n\n#### Example Usage\n\n```bash\n# Set API key\nosintleak --key <your_api_key>\n\n# Perform a search\nosintleak -q ahmed\n\n# Fetch recent search results by ID\nosintleak -r <result_id> -p 2\n\n# Save output to a file\nosintleak -q example.com -t url -o output.txt\n```\n\nFeel free to explore more options and functionalities by checking the help:\n\n```bash\nosintleak --help\n```\n\n## Contributing\n\nIf you encounter any issues or have suggestions for improvements, please feel free to contribute by opening an issue or submitting a pull request on [GitHub](https://github.com/osintleak/pyosintleak). Your feedback is highly appreciated!\n",
"bugtrack_url": null,
"license": null,
"summary": "pyosintleak is a library designed for utilizing the osintleak API, facilitating integration and automation of open-source intelligence operations.",
"version": "1.0.1",
"project_urls": {
"Download": "https://github.com/osintleak/pyosintleak/archive/v1.0.1.zip",
"Homepage": "https://github.com/osintleak/pyosintleak"
},
"split_keywords": [
"osintleak",
" osint",
" leak",
" breach",
" search",
" ol",
" pentesting"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5ca30c9704416040e6f88a39bc95e3cfbfcf8973276e044762d125b82688ef3a",
"md5": "8fb1c5bdd7b1932be8c9d2f2137c28e8",
"sha256": "725fcad27b462cc1ff172b310f8a49170f14a426ef72c431f1925a19a40141c4"
},
"downloads": -1,
"filename": "pyosintleak-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8fb1c5bdd7b1932be8c9d2f2137c28e8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3",
"size": 5678,
"upload_time": "2024-04-19T14:23:31",
"upload_time_iso_8601": "2024-04-19T14:23:31.548274Z",
"url": "https://files.pythonhosted.org/packages/5c/a3/0c9704416040e6f88a39bc95e3cfbfcf8973276e044762d125b82688ef3a/pyosintleak-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6495b4a8eab15d2e007209280c7d4c8273249537da8124d9e9c6abb7dd567a76",
"md5": "744c11fed3492502f565bea0945de7a3",
"sha256": "0669049abeaffe073f28f4b7d37b5a75b9a3ed850e5ad6826520aeb99784faf5"
},
"downloads": -1,
"filename": "pyosintleak-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "744c11fed3492502f565bea0945de7a3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3",
"size": 5796,
"upload_time": "2024-04-19T14:23:33",
"upload_time_iso_8601": "2024-04-19T14:23:33.022678Z",
"url": "https://files.pythonhosted.org/packages/64/95/b4a8eab15d2e007209280c7d4c8273249537da8124d9e9c6abb7dd567a76/pyosintleak-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-19 14:23:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "osintleak",
"github_project": "pyosintleak",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pyosintleak"
}
JSON
