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
LOC-FLOW is an “hands-free” earthquake location workflow to process continuous seismic records

LOC-FLOW is an “hands-free” earthquake location workflow to process continuous seismic records: from raw waveforms to well located earthquakes with magnitude calculations. The package assembles sever

Miao Zhang 71 Jan 09, 2023
Backup dc registry - A simple POC that abuses Backup Operator privileges to remote dump SAM, SYSTEM, and SECURITY

Backup Operator Registry Backup to Domain Compromise A simple POC that abuses Ba

Horizon 3 AI Inc 57 Dec 18, 2022
An example module hooking system, will be used in PySAMP.

An example module hooking system, will be used in PySAMP.

2 May 01, 2022
Check COVID locations of interest against Google location history

Location of Interest Checker Script to compare COVID locations of interest to Google location history. The script produces a map plot (as shown below)

9 Mar 30, 2022
A simple API to upload notes or files to KBFS

This API can be used to upload either secure notes or files to a secure KeybaseFS folder.

Dakota Brown 1 Oct 08, 2021
fetchmesh is a tool to simplify working with Atlas anchoring mesh measurements

A Python library for working with the RIPE Atlas anchoring mesh. fetchmesh is a tool to simplify working with Atlas anchoring mesh measurements. It ca

2 Aug 30, 2022
Sublime Text 2/3 style auto completion for ST4

Hippie Autocompletion Sublime Text 2/3 style auto completion for ST4: cycle through words, do not show popup. Simply hit Tab to insert completion, hit

Alexander Schepanovski 20 May 19, 2022
Functional collections extension functions for Python

pyfuncol pyfuncol Installation Usage API Documentation Compatibility Contributing License A Python functional collections library. It extends collecti

Andrea Veneziano 32 Nov 16, 2022
A place where the most basic, basic of python coding exists

python-basics A place where the most basic, basic of python coding exists As you can see, there are four folders and the best order to read is: appeti

Chuqin 2 Oct 05, 2022
This repo contains scripts that add functionality to xbar.

xbar-custom-plugins This repo contains scripts that add functionality to xbar. Usage You have to add scripts to xbar plugin folder. If you don't find

osman uygar 1 Jan 10, 2022
Let's pretend you want to create a AWS Lambda project called "sns-processor".

Usage Let's pretend you want to create a AWS Lambda project called "sns-processor". Rather than using lambda and then editing the results to include y

1 Dec 31, 2021
A tutorial presents several practical examples of how to build DAGs in Apache Airflow

Apache Airflow - Python Brasil 2021 Este tutorial apresenta vários exemplos práticos de como construir DAGs no Apache Airflow. Background Apache Airfl

Jusbrasil 14 Jun 03, 2022
A tool to help calculate how to split conveyors in Satisfactory into specific ratios.

Satisfactory Splitter Calculator A tool to help calculate how to split conveyors in Satisfactory into specific ratios. Dependencies Python 3.9 PyYAML

RobotiCat 5 Dec 22, 2022
A simple and convenient build-and-run system for C and C++.

smake Smake is a simple and convenient build-and-run system for C and C++ projects. Why make another build system? CMake and GNU Make are great build

Venkataram Edavamadathil Sivaram 18 Nov 13, 2022
An OBS script to fuze files together

OBS TEXT FUZE Fuze text files and inject the output into a text source. The Index file directory should be a list of file directorys for the text file

SuperZooper3 1 Dec 27, 2021
An easy-to-learn, dynamic, interpreted, procedural programming language

Gen Programming Language WARNING!! THIS LANGUAGE IS IN DEVELOPMENT. ANYTHING CAN CHANGE AT ANY MOMENT. Gen is a dynamic, interpreted, procedural progr

Gen Programming Language 7 Oct 17, 2022
Github Star Tracking app with Streamlit

github-star-tracking-python-app Github Star Tracking app with Streamlit #8daysofstreamlit How to run it locally? Clone or Download & Unzip the Repo En

amrrs 4 Sep 22, 2022
Password manager using MySQL and Python 3.10.2

Password Manager Password manager using MySQL and Python 3.10.2 Installation Install my-project with github git clone https://github.com/AyaanSiddiq

1 Feb 18, 2022
Allows you to purge all reply comments left by a user on a YouTube channel or video.

YouTube Spammer Purge Allows you to purge all reply comments left by a user on a YouTube channel or video. Purpose Recently, there has been a massive

4.3k Jan 09, 2023
Active Transport Analytics Model: A new strategic transport modelling and data visualization framework

{ATAM} Active Transport Analytics Model Active Transport Analytics Model (“ATAM”

ATAM Analytics 2 Dec 21, 2022