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

Overview

Android Resources Checker

Flake8 Black Coverage License

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.

You might also like...
Graphene Metanode is a locally hosted node for one account and several trading pairs, which uses minimal RAM resources.

Graphene Metanode is a locally hosted node for one account and several trading pairs, which uses minimal RAM resources. It provides the necessary user stream data and order book data for trading in a format one would expect from a centralized exchange API.

ARA Records Ansible and makes it easier to understand and troubleshoot.
ARA Records Ansible and makes it easier to understand and troubleshoot.

ARA Records Ansible ARA Records Ansible and makes it easier to understand and troubleshoot. It's another recursive acronym. What it does Simple to ins

All you need to understand CRUD and MVP in DRF
All you need to understand CRUD and MVP in DRF

Book-Store-API This an API which has been put in place just to make you order for books, upload books with price, image and all, pay and automtically

This repository provides a set of easy to understand and tested Python samples for using Acronis Cyber Platform API.

Base Acronis Cyber Platform API operations with Python !!! info Copyright © 2019-2021 Acronis International GmbH. This is distributed under MIT licens

🎅🏻 Helping santa understand ✨ python ✨

☃️ Advent of code 2021 ☃️ Helping santa understand ✨ python ✨

Users can read others' travel journeys in addition to being able to upload and delete posts detailing their own experiences

Users can read others' travel journeys in addition to being able to upload and delete posts detailing their own experiences! Posts are organized by country and destination within that country.

An open letter in support of Richard Matthew Stallman being reinstated by the Free Software Foundation

An open letter in support of RMS. To sign, click here and name the file username.yaml (replace username with your name) with the following content

Neogex is a human readable parser standard, being implemented in Python

Neogex (New Expressions) Parsing Standard Much like Regex, Neogex allows for string parsing and validation based on a set of requirements. Unlike Rege

Get information about what a Python frame is currently doing, particularly the AST node being executed

executing This mini-package lets you get information about what a frame is currently doing, particularly the AST node being executed. Usage Getting th

Comments
  • Issues with MIT licensing

    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 :

    It's also worth to highlight that deploys on Pypiship 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

    opened by ubiratansoares 2
  • ERROR: Could not complete analysis.

    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

    opened by GianfrancoMS 0
  • support multiple clients

    support multiple clients

    What

    • Renamed --app-path to --app
    • Renamed --client-path to --client
    • Add ability to provide multiple clients.
      • This is done via the --client flag; you should use one for each of the clients.
    opened by fabiocarballo 0
Releases(v0.0.10)
  • v0.0.10(Apr 8, 2021)

    Version 0.0.10

    2021-05-08

    • Specify automatic deletion of unused resources via the --delete flag.
    • Fixes bugs in deletion that incorrectly deleted entries in file and whole files.
    Source code(tar.gz)
    Source code(zip)
  • v0.0.9(Apr 7, 2021)

    Version 0.0.9

    2021-04-07

    • Fix bug that was not considering resource names with '0' in the name.
    • Fix bug that was not considering all files of the project.
    Source code(tar.gz)
    Source code(zip)
  • v0.0.8(Apr 7, 2021)

    Version 0.0.8

    2021-04-07

    • Add ability to use it as a validation tool using the --check option.
    • Specify the type of report using the --report=(CSV|STDOUT) (the default is to run all).
    • Fixes bug that didn't check for resource usages in the AndroidManifest.xml
    Source code(tar.gz)
    Source code(zip)
  • v0.0.7(Apr 4, 2021)

    Version 0.0.7

    2021.04.05

    • Add inspection to style resources.
    • Update LICENSE.md and README.md with due copyright to Dotanuki Labs given that the structure/base of this project was highly inspired from Bitrise Reports.
    Source code(tar.gz)
    Source code(zip)
  • v0.0.6(Apr 2, 2021)

    Version 0.0.6

    2021-04-02

    • Add CSV reports via the --reports-dir option.
    • Fixes bug that ignored that didn't process resources that are not xml (such as the ones usually placed on raw)
    Source code(tar.gz)
    Source code(zip)
  • v0.0.4(Apr 1, 2021)

    Version 0.0.4

    2021-04-01

    • Add inspection to resources declared as entries (string, color, dimen)
    • Renamed --app-path to --app
    • Renamed --client-path to --client
    • Add ability to provide multiple clients.
      • This is done via the --client flag; you should use one for each of the clients.
    Source code(tar.gz)
    Source code(zip)
  • v0.0.3(Mar 29, 2021)

    Version 0.0.3

    2021-03-29

    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
    Source code(tar.gz)
    Source code(zip)
Owner
Fábio Carballo
Fábio Carballo
Graphsignal Logger

Graphsignal Logger Overview Graphsignal is an observability platform for monitoring and troubleshooting production machine learning applications. It h

Graphsignal 143 Dec 05, 2022
Module 2's katas from Launch X's python introduction course.

Module2Katas Module 2's katas from Launch X's python introduction course. Virtual environment creation process (on Windows): Create a folder in any de

Javier Méndez 1 Feb 10, 2022
Calibre Libgen Non-fiction / Sci-tech store plugin

CalibreLibgenSci A Libgen Non-Fiction/Sci-tech store plugin for Calibre Installation Download the latest zip file release from here Open Calibre Navig

IDDQD 9 Dec 27, 2022
FCurve-Cleaner: Tries to clean your dense mocap graphs like an animator would

Tries to clean your dense mocap graphs like an animator would! So it will produce a usable artist friendly result while maintaining the original graph.

wiSHFul97 5 Aug 17, 2022
Watcher for systemdrun user scopes

Systemctl Memory Watcher Animated watcher for systemdrun user scopes. Usage Launch some process in your GNU-Linux or compatible OS with systemd-run co

Antonio Vanegas 2 Jan 20, 2022
A project for the Qvault Hackathon, 2022-01-17

musical-octo-engine Steps to run brew install python-tk brew install portaudio

Erik Kristofer Anderson 2 May 17, 2022
Unzip Japanese Shift-JIS zip archives on non-Japanese systems.

Unzip JP GUI Unzip Japanese Shift-JIS zip archives on non-Japanese systems. This script unzips the file while converting the file names from Shift-JIS

Emile Bangma 9 Dec 07, 2022
Creates infinite amount of guilded accounts in seconds.

Guilded Cookie Creator [fuck guilded i quit working on this, they patch like every fucking method after 2/3 days i release shit] Optimizations Asynchr

scripted 7 Feb 28, 2022
A reference implementation for processing the content.log files found at opendata.dwd.de/weather

A reference implementation for processing the content.log files found at opendata.dwd.de/weather.

Deutscher Wetterdienst (DWD) 6 Nov 26, 2022
A tool to nowcast quarterly data with monthly indicators: US consumption example

MIDAS_Nowcaster A tool to nowcast quarterly data with monthly indicators: US consumption example Pulls data directly from FRED from a list of codes -

Gene Kindberg-Hanlon 3 Oct 06, 2022
Visual Python and C++ nanosecond profiler, logger, tests enabler

Look into Palanteer and get an omniscient view of your program Palanteer is a set of lean and efficient tools to improve the quality of software, for

Damien Feneyrou 1.9k Dec 26, 2022
Snack Rice - A Rice University servery finder, customized for your needs!

Snack Rice - A Rice University servery finder, customized for your needs!

Aidan Gerber 3 Sep 25, 2022
Pyhexdmp - Python hex dump module

Pyhexdmp - Python hex dump module

25 Oct 23, 2022
Rates how pog a word or user is. Not random and does have *some* kind of algorithm to it.

PogRater :D Rates how pogchamp a word is :D A fun project coded by JBYT27 using Python3 Have you ever wondered how pog a word is? Well, congrats, you

an aspirin 2 Jun 25, 2022
Python framework to build apps with the GASP metaphor

Gaspium Python framework to build apps with the GASP metaphor This project is part of the Pyrustic Open Ecosystem. Installation | Documentation | Late

5 Jan 01, 2023
A lightweight Python module to interact with the Mitre Att&ck Enterprise dataset.

enterpriseattack - Mitre's Enterprise Att&ck A lightweight Python module to interact with the Mitre Att&ck Enterprise dataset. Built to be used in pro

xakepnz 7 Jan 01, 2023
OnTime is a small python that you set a time and on that time, app will send you notification and also play an alarm.

OnTime Always be OnTime! What is OnTime? OnTime is a small python that you set a time and on that time, app will send you notification and also play a

AmirHossein Mohammadi 11 Jan 16, 2022
PyWorkflow(PyWF) - A Python Binding of C++ Workflow

PyWorkflow(PyWF) - A Python Binding of C++ Workflow 概览 C++ Workflow是一个高性能的异步引擎,本项目着力于实现一个Python版的Workflow,让Python用户也能享受Workflow带来的绝佳体验。

Sogou-inc 108 Dec 01, 2022
An implementation of multimap with per-item expiration backed up by Redis.

MultiMapWithTTL An implementation of multimap with per-item expiration backed up by Redis. Documentation: https://loggi.github.io/python-multimapwitht

Loggi 2 Jan 17, 2022
Hacktoberfest2021 🥳- Contribute Any Pattern In Any Language😎 Every PR will be accepted Pls contribute

✨ Hacktober Fest 2021 ✨ 🙂 All Contributors are requested to star this repo and follow me for a successful merge of pull request. 🙂 👉 Add any patter

Md. Almas Ali 103 Jan 07, 2023