fabiocarballo / android-resources-checker Goto Github PK

Inspect the resources of your android projects and understand which ones are not being used and could potentially be removed.

License: MIT License

Python 98.56% Makefile 1.44%

android android-resources

android-resources-checker's Introduction

Android Resources Checker

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:

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:

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:

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:

Reports

The default behavior is to generate reports on both the stdout and CSV.

You can specify a single type of report using the --report=(CSV|STDOUT) option.

If using CSV reports, you can specify the directory where to write the reports in the form of CSV files. For that use the --reports-dir option.

For example:

android-resources-checker \
  --app /path/to/app \ 
  --reports-dir /path/to/reports

Validation

There is also the option to run this as a validation tool. In this case, it will fail with an error if any unused resources are found.

To specify the validation use the --check flag (the default behavior is to perform no validation).

Automatic Deletion

You can use this tool to also delete the unused resources by using the --delete option.

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.

android-resources-checker's People

Contributors

Stargazers

Watchers

Forkers

android-resources-checker's Issues

Issues with MIT licensing

First of all, congrats for the good job on this tool. Looks quite great!

It's quite hard to say that, but it seems that your project is not compliant with MIT license at all.

The reason for that is simple : your project takes A LOT of inspiration from the open-source work I've been doing at @dotanuki-labs. Particularly it is easy to realise that when comparing this project with bitrise-reports

I can list a few of them:

Same project structure driven by Poetry + Makefile (including some targets using the same names)
Same Github Actions Workflows (main.yml and publish.yml), incluing Job's names, Python versions, pipeline steps
Very similar file structure (entrypoint.py, reporting.py, app.py, etc)
Very similar file contents, as per entrypoint.py (from bitrise-reports) and entrypoint.py (from this project)

Hell, even some lines of README look the same ... and this init kinda makes crystal clear that inspiration maybe went too far ...

Open-source is meant to be collaborative and inspirational, yes. For sure I have no issues with people forking, modifying and/or re-distributing my code. Most likely that proves I'm in a good track at all.

However, licensing is important. Attribution is important. This article does a terrific job elaborating on that

I love inspiring other people to do awesome stuff based on some of my concepts and thoughts and 
I’m happy when I could help you with my code. So everybody is free to use my code, but now the 
important part, under the given license terms. You could also say “credit where credits needed”. 

Open source in the context of software does not mean you can copy the nice stuff and paste 
it into your project and tell everybody you did a nice job.

I can't recommend enough also checking these two extra resources to understand how MIT license works :

Choose a license on MIT
Wikipedia on MIT

It's also worth to highlight that deploys on Pypi ship the source code exactly as it was written, which means that you've shipped snippets and/or entire pieces of code written by me without proper attribution while re-distributing.

All of that being said : I'd like to ask you to change your LICENSE.md and README.md files with the following notice

Copyright (c) 2021 Dotanuki Labs, Fabio Carballo

[rest of the license terms]

so your project becomes compliant with MIT and plays well with open-source. I won't bother about previous releases wrongly copyrighted if you gently commit with this suggestion and deploy a new version of this project, so users can get the proper copyrighted code when installing / updating this tool.

I'm assuming here this issue eventually comes from some lacking of experience with open-source from your end, and* that is totally fine. Knowing you from our days working together at N26 I'm 100% sure you don't need such copy+pasta over other Engineer's work.

Thanks in advance

Is this possible to runs for Dynamic Feature Modules?

ERROR: Could not complete analysis.

Hi, I'm trying to run this script on my project (muli-module setup) and I am having this problem:

Processing:
[14:52:52] rappi - packaged resources processed!                       app.py:31
ERROR:root:Could not complete analysis.
Traceback (most recent call last):
  File "/Users/usuario/.pyenv/versions/3.9.7/lib/python3.9/site-packages/android_resources_checker/entrypoint.py", line 81, in launch
    application.execute(app, client, check, delete)
  File "/Users/usuario/.pyenv/versions/3.9.7/lib/python3.9/site-packages/android_resources_checker/app.py", line 33, in execute
    usage_references = self.resources_fetcher.fetch_used_resources(app_path)
  File "/Users/usuario/.pyenv/versions/3.9.7/lib/python3.9/site-packages/android_resources_checker/resources.py", line 73, in fetch_used_resources
    styles_references = self._style_usages_in_xml(filepath)
  File "/Users/usuario/.pyenv/versions/3.9.7/lib/python3.9/site-packages/android_resources_checker/resources.py", line 113, in _style_usages_in_xml
    for line in self.files_handler.file_content(filepath):
  File "/Users/usuario/.pyenv/versions/3.9.7/lib/python3.9/site-packages/android_resources_checker/files.py", line 33, in file_content
    return open(filepath).readlines()
  File "/Users/usuario/.pyenv/versions/3.9.7/lib/python3.9/codecs.py", line 322, in decode
    (result, consumed) = self._buffer_decode(data, self.errors, final)
UnicodeDecodeError: 'utf-8' codec can't decode byte 0xe1 in position 1: invalid continuation byte

Python version: 3.9.7
OS: macOS Monterrey 12.0.1