peepapp-core


Namepeepapp-core JSON
Version 0.1.1 PyPI version JSON
download
home_pagehttps://github.com/oatkrs/peepapp-core
SummaryCore library for PeepApp, a SAST tool for analyzing Android apps and enumerating trackers and permissions.
upload_time2024-08-12 11:04:57
maintainerNone
docs_urlNone
authorUtkarsh
requires_python>=3.11
licenseMIT
keywords
VCS
bugtrack_url
requirements androguard cryptography dhash jellyfish Pillow requests six traitlets
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # 🌟 **PeepApp Core** 🌟
Welcome to **PeepApp Core** – the heart of your app security journey! 🔐 This core library powers **PeepApp**, your go-to tool for performing SAST (Static Application Security Testing) on Android apps. Whether you're diving into an APK or analyzing a Google Play Store link, **PeepApp** has you covered, helping you uncover hidden trackers and permissions! 🚨

## 🚀 **Features** 🚀
✨ **Static Analysis** – Dissect those APKs with precision!  
🔍 **Network Analysis** – Peek into app communications!  
🌐 **Connection Helper** – Smooth connections, streamlined processes!

## 📦 **Installation** 📦
Get started in a snap! **PeepApp Core** is just a pip away! 🐍

```shell
pip install peepapp-core
```

## 🛠️ **Include in Your Project** 🛠️
Easily integrate **PeepApp Core** by adding it to your `requirements.txt`. Just replace 'XX' with your desired subversion:

```text
peepapp-core==XX
```

## 💻 **Local Usage** 💻
Ready to roll up your sleeves? Follow these steps to get started locally! 💪

### 1️⃣ **Clone the Repository** 🧬
Get your hands on the code:

```shell
git clone https://github.com/oatkrs/peepapp-core.git
cd peepapp-core
```

### 2️⃣ **Using Docker? We've Got You!** 🐳
Spin up a Docker container in no time:

```shell
docker build -t peepapp-core .
```

Run tests with ease:

```shell
docker run -it --rm peepapp-core /bin/bash
python -m unittest discover -s peepapp_core -p "test_*.py"
```

### 3️⃣ **Prefer Manual Installation? No Problem!** 🔧
Start by installing `dexdump`:

```shell
sudo apt-get install dexdump
```

Set up a Python `virtualenv`:

```shell
virtualenv venv -p python3
source venv/bin/activate
```

Install all dependencies:

```shell
pip install -r requirements.txt
```

Run the tests:

```shell
python -m unittest discover -s peepapp_core -p "test_*.py"
```

---

Dive in, and let's make app security and user privacy a breeze! 🛡️

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/oatkrs/peepapp-core",
    "name": "peepapp-core",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.11",
    "maintainer_email": null,
    "keywords": null,
    "author": "Utkarsh",
    "author_email": "oatkrs <utkarshparashar05@example.com>",
    "download_url": null,
    "platform": null,
    "description": "# \ud83c\udf1f **PeepApp Core** \ud83c\udf1f\nWelcome to **PeepApp Core** \u2013 the heart of your app security journey! \ud83d\udd10 This core library powers **PeepApp**, your go-to tool for performing SAST (Static Application Security Testing) on Android apps. Whether you're diving into an APK or analyzing a Google Play Store link, **PeepApp** has you covered, helping you uncover hidden trackers and permissions! \ud83d\udea8\n\n## \ud83d\ude80 **Features** \ud83d\ude80\n\u2728 **Static Analysis** \u2013 Dissect those APKs with precision!  \n\ud83d\udd0d **Network Analysis** \u2013 Peek into app communications!  \n\ud83c\udf10 **Connection Helper** \u2013 Smooth connections, streamlined processes!\n\n## \ud83d\udce6 **Installation** \ud83d\udce6\nGet started in a snap! **PeepApp Core** is just a pip away! \ud83d\udc0d\n\n```shell\npip install peepapp-core\n```\n\n## \ud83d\udee0\ufe0f **Include in Your Project** \ud83d\udee0\ufe0f\nEasily integrate **PeepApp Core** by adding it to your `requirements.txt`. Just replace 'XX' with your desired subversion:\n\n```text\npeepapp-core==XX\n```\n\n## \ud83d\udcbb **Local Usage** \ud83d\udcbb\nReady to roll up your sleeves? Follow these steps to get started locally! \ud83d\udcaa\n\n### 1\ufe0f\u20e3 **Clone the Repository** \ud83e\uddec\nGet your hands on the code:\n\n```shell\ngit clone https://github.com/oatkrs/peepapp-core.git\ncd peepapp-core\n```\n\n### 2\ufe0f\u20e3 **Using Docker? We've Got You!** \ud83d\udc33\nSpin up a Docker container in no time:\n\n```shell\ndocker build -t peepapp-core .\n```\n\nRun tests with ease:\n\n```shell\ndocker run -it --rm peepapp-core /bin/bash\npython -m unittest discover -s peepapp_core -p \"test_*.py\"\n```\n\n### 3\ufe0f\u20e3 **Prefer Manual Installation? No Problem!** \ud83d\udd27\nStart by installing `dexdump`:\n\n```shell\nsudo apt-get install dexdump\n```\n\nSet up a Python `virtualenv`:\n\n```shell\nvirtualenv venv -p python3\nsource venv/bin/activate\n```\n\nInstall all dependencies:\n\n```shell\npip install -r requirements.txt\n```\n\nRun the tests:\n\n```shell\npython -m unittest discover -s peepapp_core -p \"test_*.py\"\n```\n\n---\n\nDive in, and let's make app security and user privacy a breeze! \ud83d\udee1\ufe0f\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Core library for PeepApp, a SAST tool for analyzing Android apps and enumerating trackers and permissions.",
    "version": "0.1.1",
    "project_urls": {
        "Homepage": "https://github.com/oatkrs/peepapp-core"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "05c02a1b79d239680a973ff9f2b5a11807406c0834a7208c0bfdd329b0a920bd",
                "md5": "11f2937af19e7707378d6aa352fed420",
                "sha256": "7ad296eb7263dddb20e0c6be5963f29a37a7fc017dea09731dda1d77e2117da4"
            },
            "downloads": -1,
            "filename": "peepapp_core-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "11f2937af19e7707378d6aa352fed420",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.11",
            "size": 14400,
            "upload_time": "2024-08-12T11:04:57",
            "upload_time_iso_8601": "2024-08-12T11:04:57.950383Z",
            "url": "https://files.pythonhosted.org/packages/05/c0/2a1b79d239680a973ff9f2b5a11807406c0834a7208c0bfdd329b0a920bd/peepapp_core-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-08-12 11:04:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "oatkrs",
    "github_project": "peepapp-core",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [
        {
            "name": "androguard",
            "specs": [
                [
                    "==",
                    "4.1.1"
                ]
            ]
        },
        {
            "name": "cryptography",
            "specs": [
                [
                    "==",
                    "42.0.4"
                ]
            ]
        },
        {
            "name": "dhash",
            "specs": [
                [
                    "==",
                    "1.4"
                ]
            ]
        },
        {
            "name": "jellyfish",
            "specs": [
                [
                    "==",
                    "0.5.6"
                ]
            ]
        },
        {
            "name": "Pillow",
            "specs": [
                [
                    "==",
                    "10.3.0"
                ]
            ]
        },
        {
            "name": "requests",
            "specs": [
                [
                    "==",
                    "2.32.0"
                ]
            ]
        },
        {
            "name": "six",
            "specs": [
                [
                    "==",
                    "1.15.0"
                ]
            ]
        },
        {
            "name": "traitlets",
            "specs": [
                [
                    "==",
                    "4.3.2"
                ]
            ]
        }
    ],
    "lcname": "peepapp-core"
}
        
Elapsed time: 0.43006s