split-dex 0.1.0__tar.gz

split_dex-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+# Cancel superseded runs on the same ref.
+concurrency:
+  group: ci-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  check:
+    name: lint, types & tests
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v7
+      # setup-uv has no major-version tags (v10) since v8: pin a full version.
+      - uses: astral-sh/setup-uv@v10.3.2
+        with:
+          python-version: "3.14"
+          enable-cache: true
+      - name: Install
+        run: uv sync --locked
+      - name: Check formatting
+        run: uv run ruff format --check
+      - name: Lint
+        run: uv run ruff check
+      - name: Type-check
+        run: uv run mypy
+      - name: Test
+        run: uv run pytest

split_dex-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,94 @@
+name: Release
+
+# A v* tag builds the wheel and the sdist, checks that the wheel installs and runs, and publishes
+# both as a GitHub release, with the matching CHANGELOG.md section as the notes, then on PyPI.
+# Pull requests that touch the packaging, and manual runs, build and check everything without
+# publishing.
+on:
+  push:
+    tags: ["v*"]
+  pull_request:
+    paths:
+      - .github/workflows/release.yml
+      - pyproject.toml
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: wheel and sdist
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v7
+      # setup-uv has no major-version tags (v10) since v8: pin a full version.
+      - uses: astral-sh/setup-uv@v10.3.2
+        with:
+          python-version: "3.14"
+      - name: Build
+        run: uv build
+      # Install the wheel as users will, with dexpp from PyPI.
+      - name: Install the wheel and run it
+        run: |
+          uv venv /tmp/smoke
+          uv pip install --python /tmp/smoke/bin/python dist/*.whl
+          /tmp/smoke/bin/split-dex --list-strategies
+      - uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/*
+
+  release:
+    name: GitHub release
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: [build]
+    runs-on: ubuntu-24.04
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist
+      - name: Check the tag matches the version
+        run: |
+          version=$(sed -n 's/^version = "\(.*\)"$/\1/p' pyproject.toml)
+          if [ "v$version" != "$GITHUB_REF_NAME" ]; then
+            echo "tag $GITHUB_REF_NAME does not match pyproject.toml ($version)"
+            exit 1
+          fi
+          echo "VERSION=$version" >> "$GITHUB_ENV"
+      - name: Extract release notes
+        run: |
+          # The CHANGELOG.md section for this version, without its heading.
+          awk -v v="$VERSION" '
+            /^## / { if (found) exit; if (index($0, "## " v " ") == 1 || $0 == "## " v) { found = 1; next } }
+            found { print }
+          ' CHANGELOG.md > notes.md
+          test -s notes.md
+      - name: Create release
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          gh release create "$GITHUB_REF_NAME" dist/* \
+            --title "split-dex $VERSION" --notes-file notes.md
+
+  pypi:
+    name: PyPI
+    # After the GitHub release, so the tag check above also guards this upload: PyPI never accepts
+    # the same version twice.
+    needs: [release]
+    runs-on: ubuntu-24.04
+    # PyPI trusts uploads from this workflow file running in this environment (trusted
+    # publishing), so no API token is stored anywhere. The repository settings allow the
+    # environment only for v* tags.
+    environment:
+      name: pypi
+      url: https://pypi.org/project/split-dex/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist
+      - uses: pypa/gh-action-pypi-publish@release/v1

split_dex-0.1.0/.gitignore

@@ -0,0 +1,24 @@
+# IDE files
+.idea/
+.vscode/
+*.iml
+
+# Python
+.venv/
+__pycache__/
+*.egg-info/
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+build/
+dist/
+
+# OS files
+.DS_Store
+Thumbs.db
+
+# Backup files
+*~
+*.bak
+*.swp
+*.swo

split_dex-0.1.0/.python-version

@@ -0,0 +1 @@
+3.14

split_dex-0.1.0/CHANGELOG.md

@@ -0,0 +1,27 @@
+# Changelog
+
+## 0.1.0
+
+First release of `split-dex`: a Python package with a `split-dex` command,
+built on dexpp's Python binding. It needs Python 3.14 or newer and dexpp
+0.2.0, and is licensed under the Apache License 2.0.
+
+- Splits an APK's classes into grouped DEX files. `--set` declares sets of
+  classes and the strategy that splits each one, and `--assign` sends classes
+  to sets by patterns on their names. Two sets never share a DEX file.
+- Built-in strategies: `package-affinity` (classes grouped by how they are
+  linked, a Java package never split across files), `package-order` (whole
+  packages in name order, without reading the code), `original` (the input DEX
+  layout, optionally merged down to a number of files) and `single` (one DEX
+  file). `--list-strategies` shows them and their settings.
+- A strategy of your own can be used from a file (`FILE.py:CLASS`), a module
+  (`MODULE:CLASS`), or an installed plugin (entry-point group
+  `split_dex.strategies`). Strategies can read the links between classes with a
+  weight per kind of link, and dexpp's analysis of the APK.
+- Writes `index.csv` (`class,file`) and `sets.csv` (`file,set`) next to the
+  DEX files.
+- A group over the 64K DEX reference limit is cut at the block boundary nearest
+  its middle (a package, for `package-affinity` and `package-order`). A single
+  package too big for one DEX file is cut and reported with a warning.
+- A class defined in more than one DEX file is written once: the first copy in
+  multidex order.

split_dex-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

split_dex-0.1.0/PKG-INFO

@@ -0,0 +1,253 @@
+Metadata-Version: 2.5
+Name: split-dex
+Version: 0.1.0
+Summary: Split the classes of an Android APK into grouped DEX files
+Project-URL: Homepage, https://github.com/burogurama/split-dex
+Project-URL: Issues, https://github.com/burogurama/split-dex/issues
+Project-URL: Changelog, https://github.com/burogurama/split-dex/blob/main/CHANGELOG.md
+Author: Mohamed Nasser
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: android,apk,dex,multidex,split
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Typing :: Typed
+Requires-Python: >=3.14
+Requires-Dist: dexpp<0.3,>=0.2.0
+Description-Content-Type: text/markdown
+
+# split-dex
+
+`split-dex` splits the classes of an Android APK into grouped DEX files.
+
+It reads every `classes*.dex` in the APK, sorts the classes into sets, and
+splits each set into DEX files with a strategy. Both are chosen on the command
+line. Every class ends up in exactly one output DEX file, two sets never share a
+file, and maps record where each class went.
+
+It is written in Python, on the Python binding of
+[dexpp](https://github.com/burogurama/dexpp), which reads, analyses and writes
+the DEX files.
+
+## Usage
+
+```sh
+split-dex --apk app.apk --out out/
+```
+
+With no other option, every class is in one set, `all`, split by the
+`package-affinity` strategy into files of about 1000 classes.
+
+| Option | Meaning |
+| ------ | ------- |
+| `--apk FILE` | Input APK. All its `classes*.dex` entries are read. Required. |
+| `--out DIR` | Output directory. Created if it does not exist. Required. |
+| `--set NAME=STRATEGY[,KEY=VALUE...]` | A set of classes and the strategy that splits it, with the strategy's settings. `STRATEGY` is a built-in or plugin name (`--list-strategies` shows them), or your own class as `MODULE:CLASS` or `FILE.py:CLASS` (see [Writing a strategy](#writing-a-strategy)). Repeat it for more sets. The DEX files are written set by set, in this order. |
+| `--assign PATTERN[,PATTERN...]=NAME` | Send the classes whose names match a pattern to the set `NAME`. Repeat it; each class goes to the first pattern it matches. |
+| `--list-strategies` | Show the strategies and their settings. |
+
+With a single `--set`, `--assign` is not needed: every class goes to that set.
+With several, every class must match some pattern; end with `'**=NAME'` to
+catch the rest.
+
+A DEX file can reference at most 65,536 methods, 65,536 fields and 65,535
+types. When a group of classes goes over one of these limits, it is cut in two,
+and each half is written again (and cut again if needed). The cut falls nearest
+the middle, between the units the strategy keeps together, such as packages.
+Only a unit too big for one DEX file is cut inside, and `split-dex` prints a
+warning that names it.
+
+If the APK defines a class in more than one DEX file, only the first copy in
+multidex order is kept. That is the copy Android loads.
+
+### Patterns
+
+Patterns match class names such as `com.myapp.Main` or `com.myapp.Outer$Inner`.
+`*` matches any characters except a dot, and `**` matches any characters:
+
+| Pattern | Matches |
+| ------- | ------- |
+| `com.myapp.**` | Every class under `com.myapp`, subpackages included. |
+| `com.myapp.*` | The classes directly in `com.myapp`. |
+| `com.myapp.Main` | One class. |
+| `**` | Every class. |
+| `@FILE` | The patterns listed in `FILE`, one per line. Blank lines and lines starting with `#` are skipped. |
+
+### Examples
+
+Smaller files:
+
+```sh
+split-dex --apk app.apk --out out/ --set all=package-affinity,cap=500
+```
+
+Split the app's own classes, and put all the library classes in one DEX file
+(cut in halves where it goes over the 64K limits):
+
+```sh
+split-dex --apk app.apk --out out/ \
+    --set app=package-affinity,cap=500 \
+    --set libraries=single \
+    --assign 'com.myapp.**=app' \
+    --assign '**=libraries'
+```
+
+Split the app's own classes, but keep some of its packages with the libraries,
+which stay in their original DEX files (at most 16):
+
+```sh
+split-dex --apk app.apk --out out/ \
+    --set app=package-affinity,cap=1000 \
+    --set libraries=original,max_files=16 \
+    --assign '@startup-packages.txt=libraries' \
+    --assign 'com.myapp.**=app' \
+    --assign '**=libraries'
+```
+
+## Output
+
+In the output directory:
+
+| File        | Content                                                 |
+| ----------- | ------------------------------------------------------- |
+| `<k>.dex`   | The DEX files: `0.dex`, `1.dex`, ..., set by set.       |
+| `index.csv` | `class,file`: every class descriptor and its DEX file.  |
+| `sets.csv`  | `file,set`: the set of each DEX file.                   |
+
+Each DEX file is a valid, standalone DEX.
+
+Running again into the same directory replaces these files. If an earlier run
+wrote more `<k>.dex` files, the extra ones are removed, so every DEX file in the
+directory is listed in `index.csv`. Other files in the directory are not
+touched.
+
+At the end, `split-dex` prints a summary: how many classes were read, how many
+files were written, how many groups had to be cut for the 64K limits, and the
+classes and files of each set.
+
+## Install
+
+split-dex needs Python 3.14 or newer. Install the `split-dex` command from
+PyPI with [uv](https://docs.astral.sh/uv/) or pip:
+
+```sh
+uv tool install split-dex
+# or
+pip install split-dex
+```
+
+Its dependency dexpp has prebuilt wheels for Linux x86_64 (glibc 2.28+ and
+musl). On other platforms, the installer builds dexpp from source, which needs
+a C++23 compiler (GCC 13 or newer, or Clang 19 or newer) and CMake 3.18 or
+newer.
+
+From a checkout, `uv tool install .` installs the command.
+
+## Writing a strategy
+
+The command-line options cover the common setups. A strategy of your own is for
+the cases they don't. A strategy is a Python class:
+
+```python
+from split_dex import strategy
+
+
+class OnePerFile:
+    """Each class in a DEX file of its own, up to `limit` files."""
+
+    def __init__(self, *, limit: int = 100) -> None:
+        self._limit = limit
+
+    def plan(self, classes: strategy.Classes) -> list[strategy.Group]:
+        ids = list(classes.ids)
+        groups = [strategy.Group.of_classes([class_id]) for class_id in ids[: self._limit - 1]]
+        return groups + [strategy.Group.of_classes(ids[self._limit - 1 :])]
+```
+
+- Its keyword-only constructor parameters are its settings. The command line
+  converts each `KEY=VALUE` to the parameter's type: int, float, bool, str or
+  Path, optionally `| None`.
+- `plan(classes)` receives the classes of one set and returns the groups to
+  write, in order. Each group (`strategy.Group`) becomes one DEX file, and is
+  made of blocks (`strategy.Block`): classes that should stay in one file.
+  When a group goes over a 64K limit, the splitter cuts it at the block
+  boundary nearest its middle. `Group.of_classes(ids)` makes one block per
+  class.
+- The splitter checks that every class of the set is in exactly one group;
+  otherwise the run fails with an error that names the strategy's mistake.
+
+What `classes` (`strategy.Classes`) gives:
+
+| Member | Meaning |
+| ------ | ------- |
+| `ids` | The class ids of the set, in multidex order. |
+| `descriptors` | The descriptor of every class of the APK, indexed by class id. |
+| `source_dex(id)` | The input DEX file of a class: 0 for `classes.dex`, 1 for `classes2.dex`, ... |
+| `links(weights=None)` | The links among the classes of the set, as a `partition.AffinityGraph`. `weights` maps a `strategy.LinkKind` (superclass, interface, nesting, call, field, type) to its weight; a kind left out weighs 1, and 0 ignores it. |
+| `analysis` | dexpp's `AnalysisContext` for the whole APK: classes, methods, call graph, class hierarchy, cross-references. |
+| `apk` | dexpp's `Apk`: manifest, resources, entries. |
+
+There are four ways to use it:
+
+- From a file: `--set all=./my_strategy.py:OnePerFile,limit=8`.
+- From a module Python can import: `--set all=my_package.strategies:OnePerFile`.
+- As a plugin. An installed package declares the strategy under the
+  entry-point group `split_dex.strategies` in its `pyproject.toml`; it is then
+  used by name, and `--list-strategies` shows it:
+
+  ```toml
+  [project.entry-points."split_dex.strategies"]
+  one-per-file = "my_package.strategies:OnePerFile"
+  ```
+
+- Built into split-dex: put the module in `split_dex/strategies/` and add the
+  class to `STRATEGIES` in `split_dex/registry.py`.
+
+A strategy is ordinary Python code that runs inside split-dex, so only use
+files, modules and plugins you trust.
+
+From Python, `split_dex.splitter.split()` takes `split_dex.splitter.Options`,
+whose sets can use any object with a `plan` method.
+
+## Development
+
+```sh
+uv sync                     # .venv with split-dex, dexpp and the dev tools
+uv run pytest               # the tests
+uv run ruff format --check  # formatting
+uv run ruff check           # lint
+uv run mypy                 # types
+```
+
+The tests build small APKs in memory. Their classes are copies of the template
+classes in `tests/data/templates.dex`, renamed for each test. The templates are
+compiled from `tests/data/Templates.java`; `tests/data/make_templates.sh`
+rebuilds them (it needs `javac` and the Android SDK's `d8`).
+
+To move to a newer dexpp, update its version range in `dependencies` in
+`pyproject.toml` and run `uv lock`.
+
+To release: set `version` in `pyproject.toml`, turn the `## Unreleased`
+section of `CHANGELOG.md` into `## <version>`, and push a `v<version>` tag. The
+release workflow builds the wheel and the sdist, checks that the wheel installs
+and runs, creates the GitHub release with that changelog section as notes, and
+uploads the same files to PyPI.
+
+## Layout
+
+- `split_dex/cli.py` — the command-line interface.
+- `split_dex/splitter.py` — reads the APK, sorts the classes into sets, runs
+  each set's strategy, checks its groups, and writes the DEX files and maps.
+- `split_dex/class_sets.py` — sets, patterns, and how classes are assigned.
+- `split_dex/strategy.py` — the interface between the splitter and strategies.
+- `split_dex/registry.py` — finds strategies (built-in, plugin, module or file)
+  and creates them from their settings.
+- `split_dex/strategies/` — the built-in strategies.
+- `split_dex/partition.py` — the package-affinity grouping algorithm.
+- `tests/` — the unit tests (pytest).