Metadata-Version: 2.1
Name: android-resources-checker
Version: 0.0.7
Summary: Check if your android resources are being unused.
Home-page: https://github.com/fabiocarballo/android-resources-checker
License: MIT
Author: Fabio Carballo
Author-email: fabio.og.carballo@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: click (>=7.1.2,<8.0.0)
Requires-Dist: rich (>=10.0.0,<11.0.0)
Project-URL: Repository, https://github.com/fabiocarballo/android-resources-checker
Description-Content-Type: text/markdown

# Android Resources Checker


[![Flake8](https://img.shields.io/badge/codestyle-flake8-yellow)](https://flake8.pycqa.org/en/latest/)
[![Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Coverage](https://codecov.io/gh/fabiocarballo/android-resources-checker/branch/master/graph/badge.svg)](https://codecov.io/gh/fabiocarballo/android-resources-checker)
[![License](https://img.shields.io/github/license/fabiocarballo/android-resources-checker)](https://choosealicense.com/licenses/mit)

## What

This program will inspect the resources of your app and help you understand which ones are not being used and could
potentially be removed.

Main features:

- Identify the unused resources in your android project.
- Identify the unused resources in your android library (when you have a multi-repo setup)
- Listing of the unused resources (name, type and size)
- Deletion of the unused resources

## Installing

This program requires Python, supporting from 3.8.x and 3.9.x

In order to install run:

```shell
pip install -U android-resources-checker
```

## Using

## Inspecting your app resources.

Imagining your app in the project `subject-app`, you can trigger the resources inspection by running:

```shell
android-resources-checker --app /path/to/subject-app
```

## Inspecting your library app resources.

In the case you have two projects in separate repos, where a `client-app` depends on a `lib-app`, you can check the unused
resources of the library app by running:

```shell
android-resources-checker \
  --app /path/to/lib-app \
  --client /path/to/client-app-1 \
  --client /path/to/client-app-2
```

An example of a run could look like this:

![](.github/assets/example-terminal.png)

## Reports

The default report will be always be displayed in your stdout.

You can specify an optional directory where to write the reports in the form of CSV files. For that use the `--reports-dir` 
option.

For example:

```shell
android-resources-checker \
  --app /path/to/app \ 
  --reports-dir /path/to/reports
```
## License

```
Copyright (c) 2021 Dotanuki Labs, Fabio Carballo

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```





