openshield

Name	openshield JSON
Version	0.1.1 JSON
	download
home_page	https://github.com/jaedsonpys/openshield
Summary	OpenShield, a fast and easy-to-use CLI antivirus.
upload_time	2023-06-20 03:35:51
maintainer
docs_url	None
author	Jaedson Silva
requires_python	>=3.7
license	MIT
keywords	antivirus malware scanner cli
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # OpenShield

OpenShield is a simple and fast antivirus that allows you to scan various files to find malware on your computer. The database used to perform the malware search comes from [MalwareBazaar](https://bazaar.abuse.ch/export). The project is written in Python and open-source, it can be used via command-line interface (CLI).

## Getting started

Install the program using the PIP package manager or install it manually by cloning the repository:

```
pip install openshield
```
```
git clone https://github.com/jaedsonpys/openshield.git
cd openshield/
python3 setup.py install
```

## How to use

To scan files and/or directories, use the `openshield scan` command and pass as argument the name of the directory or file. Here is an example:

```
openshield scan ~/Downloads
```

Now scanning multiple files at once:

```
openshield scan script.py MyAplication.exe
```

You will receive a warning message if malware is found, the advice is to delete the file as soon as possible and **do not run or open** it.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/jaedsonpys/openshield",
    "name": "openshield",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "antivirus,malware,scanner,cli",
    "author": "Jaedson Silva",
    "author_email": "jaedson.dev@proton.me",
    "download_url": "https://files.pythonhosted.org/packages/c8/83/056d4a5996a95fcff127d75b05c9bfbe437a08cde4c789a5ec93bf7a3e69/openshield-0.1.1.tar.gz",
    "platform": null,
    "description": "# OpenShield\n\nOpenShield is a simple and fast antivirus that allows you to scan various files to find malware on your computer. The database used to perform the malware search comes from [MalwareBazaar](https://bazaar.abuse.ch/export). The project is written in Python and open-source, it can be used via command-line interface (CLI).\n\n## Getting started\n\nInstall the program using the PIP package manager or install it manually by cloning the repository:\n\n```\npip install openshield\n```\n```\ngit clone https://github.com/jaedsonpys/openshield.git\ncd openshield/\npython3 setup.py install\n```\n\n## How to use\n\nTo scan files and/or directories, use the `openshield scan` command and pass as argument the name of the directory or file. Here is an example:\n\n```\nopenshield scan ~/Downloads\n```\n\nNow scanning multiple files at once:\n\n```\nopenshield scan script.py MyAplication.exe\n```\n\nYou will receive a warning message if malware is found, the advice is to delete the file as soon as possible and **do not run or open** it.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "OpenShield, a fast and easy-to-use CLI antivirus.",
    "version": "0.1.1",
    "project_urls": {
        "Homepage": "https://github.com/jaedsonpys/openshield"
    },
    "split_keywords": [
        "antivirus",
        "malware",
        "scanner",
        "cli"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c883056d4a5996a95fcff127d75b05c9bfbe437a08cde4c789a5ec93bf7a3e69",
                "md5": "dbc0c438af2af14e1987018e5ef42b3c",
                "sha256": "09bfecf7398b076e56e1666ecce788311cb6621379478d019a2f9e02da0885f0"
            },
            "downloads": -1,
            "filename": "openshield-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "dbc0c438af2af14e1987018e5ef42b3c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 4720,
            "upload_time": "2023-06-20T03:35:51",
            "upload_time_iso_8601": "2023-06-20T03:35:51.007674Z",
            "url": "https://files.pythonhosted.org/packages/c8/83/056d4a5996a95fcff127d75b05c9bfbe437a08cde4c789a5ec93bf7a3e69/openshield-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-20 03:35:51",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "jaedsonpys",
    "github_project": "openshield",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "openshield"
}