archae 2026.1.0b2__py3-none-any.whl → 2026.2.0b1__py3-none-any.whl

{archae-2026.1.0b2.dist-info → archae-2026.2.0b1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: archae
-Version: 2026.1.0b2
+Version: 2026.2.0b1
 Summary: Archae explodes archives.
 Keywords: 
 Author: Shawn McNaughton
@@ -32,16 +32,19 @@ Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Programming Language :: Python
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Typing :: Typed
 Requires-Dist: click
+Requires-Dist: dynaconf>=3.2.12
+Requires-Dist: platformdirs>=4.5.1
 Requires-Dist: python-magic
+Requires-Dist: pyyaml>=6.0.3
 Requires-Dist: rich-click
-Requires-Python: ~=3.11
+Requires-Dist: types-pyyaml>=6
+Requires-Python: >=3.12
 Project-URL: Documentation, https://archae.readthedocs.io/en/stable/
 Project-URL: Changelog, https://archae.readthedocs.io/en/stable/changelog.html
 Project-URL: Source Code, https://github.com/shawngmc/archae
@@ -80,9 +83,11 @@ Every once and a while, I run into an issue: multiple layers of archives. The re
 - Identifies file types via libmagic
 - Detects duplicate archives
 - Basic archive bomb protections
-    - min_archive_size_bytes - ensures the uncompressed size of an archive is limited
-    - min_total_size_bytes - ensures the total extracted footprint isn't above a certain size
-    - min_archive_ratio - ensures very-high-compression-ratio archives are stopped
+    - MAX_ARCHIVE_SIZE_BYTES - ensures the uncompressed size of an archive is limited
+    - MAX_TOTAL_SIZE_BYTES - ensures the total extracted footprint isn't above a certain size
+    - MIN_ARCHIVE_RATIO - ensures very-high-compression-ratio archives are stopped
+    - MIN_DISK_FREE_SPACE - minimum free space at the extraction location
+    - MAX_DEPTH - allow setting a maximum archive depth to traverse
 
 ## Installation
 
@@ -102,6 +107,13 @@ Check out the [Archae documentation](https://archae.readthedocs.io/en/stable/) f
 
 ## Usage
 
+Configuration values are supplied one of four ways, and any item lower in this list will overwrite a prior one:
+
+- Default values are stored in the app
+- A TOML file at ~/.config/archae/ will be created on first run and can override those values (ex. MIN_ARCHIVE_RATIO = 0.005)
+- Env vars starts starting with "ARCHAE\_" are parsed (ex. ARCHAE_MIN_ARCHIVE_RATIO=0.005)
+- Values can be passed in as flags (ex. --min_archive_ratio=0.005)
+
 <!-- start docs-include-usage -->
 
 Running `archae --help` or `python -m archae --help` shows a list of all of the available options and arguments:
@@ -119,28 +131,18 @@ cog.outl(f"\n```sh\narchae --help\n{help.rstrip()}\n```\n")
 ```sh
 archae --help
 
- Usage: archae [OPTIONS] ARCHIVE_PATH
+ Usage: archae [OPTIONS] COMMAND [ARGS]...
 
  Archae explodes archives.
 
-╭─ Arguments ──────────────────────────────────────────────────────────────────────────╮
-│ *  ARCHIVE_PATH  FILE  Archive to examine [required]                                 │
-╰──────────────────────────────────────────────────────────────────────────────────────╯
 ╭─ Options ────────────────────────────────────────────────────────────────────────────╮
-│ --max_total_size_bytes        FILESIZE               Maximum total extraction size   │
-│                                                      before failing, default 100G    │
-│                                                      [default: 107374182400]         │
-│ --max_archive_size_bytes      FILESIZE               Maximum individual archive      │
-│                                                      extraction size before failing, │
-│                                                      default 10G [default:           │
-│                                                      10737418240]                    │
-│ --min_archive_ratio           FLOAT RANGE [0<=x<=1]  Minimum allowed compression     │
-│                                                      ratio for an archive. A         │
-│                                                      floating-point value between    │
-│                                                      0.0 and 1.0, inclusive. Default │
-│                                                      is 0.005 [default: 0.005]       │
-│ --version                 -v                         Show the version and exit.      │
-│ --help                    -h                         Show this message and exit.     │
+│ --version  -v  Show the version and exit.                                            │
+│ --help     -h  Show this message and exit.                                           │
+╰──────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Commands ───────────────────────────────────────────────────────────────────────────╮
+│ extract         Extract and analyze an archive.                                      │
+│ listopts        List all available configuration options.                            │
+│ status          Show archae status and available tools.                              │
 ╰──────────────────────────────────────────────────────────────────────────────────────╯
 ```
 
@@ -151,10 +153,7 @@ archae --help
 ## TODOs
 
 - More archive bomb protections
-    - min_total_size_bytes - (NYI) ensures the total extracted footprint isn't above a certain size
-    - min_free_space - minimum free space at the extraction location
     - delete_archives_as_exploded - remove archive files to reduce duplication (boolean)
-    - max_archive_depth - allow setting a maximum archive depth
 - Improve archive type detection
 - Separate between extractable and non-extractable archive types
 - Detect password-protected archives

archae-2026.2.0b1.dist-info/RECORD

@@ -0,0 +1,23 @@
+archae/__init__.py,sha256=O_HNvpNVsJ5LZPNPLvuHhHdOq0b6M0LnWqycB505mkQ,111
+archae/__main__.py,sha256=l3eO5dEs1cR_hDziOpnW1PYzoRL2siYm81wgvftyigg,172
+archae/cli.py,sha256=ZYq7joe10y73dCwQY7666m-SY2dej_GVEmoYRyFpg7A,5739
+archae/config.py,sha256=zGOwkPDfNLR-06ziZMXeLBamd-98AbNU0aTuoH7ibKQ,2952
+archae/default_settings.toml,sha256=svBdN9QJm8UBBz6AEWpBp-gslSBcE5n00xZdl32KDEc,230
+archae/extractor.py,sha256=CfYtsxuoXQ2rOLQIByJvLI9Y61U338dZoeb7ZBWAc_g,9948
+archae/options.yaml,sha256=nJo7gOCuiS_fKd9C3iRwI3Eb_f4OT6mbdVkipqdISpk,937
+archae/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+archae/util/__init__.py,sha256=HlENK1XfnwnYMrlkvVJTjs-6W7RLLUJOoyFcOb7njUE,34
+archae/util/archiver/__init__.py,sha256=baayr_wh2MfRaKKiVuaUxtYJcMzKR82Uf1amcU7QtzM,202
+archae/util/archiver/base_archiver.py,sha256=xEHynzmhwZdMl2fEDj9h-YaH9ZQEeaugF4H_ILoOxTY,1629
+archae/util/archiver/peazip.py,sha256=XdhI2EQ3A9EH89KxPv-FcmjukwWcS96WtG-gwkha6hs,4022
+archae/util/archiver/seven_zip.py,sha256=eck_cXMGFqwJ05ZKge3N0Ozy1XkKuGyE09s3jFcsMrQ,4951
+archae/util/archiver/unar.py,sha256=xWTR7cpFXyofvtPI-7Z5Ski605WmJdLoAm6a81IriAc,3974
+archae/util/converter/file_size.py,sha256=BdcYzpdvCDq3YH1eYW1-zwnQCxv9mBzG4DuqHY2dt6o,1984
+archae/util/enum/__init__.py,sha256=IvjtVopATKLAHDjOpblaExy2yXwIzweX0HoUrQWcpkM,109
+archae/util/enum/byte_scale.py,sha256=5TZG1msPmJU9whZtKAywZtKOre6p2xMJ2y0gE4TG3OE,1593
+archae/util/file_tracker.py,sha256=HQb1l7j_Jy0qO6tqkB8jXM6P2o5fLB6Ih0J5U4JUyT8,3106
+archae/util/tool_manager.py,sha256=HU2xkmb_18XF5SFwFV5gUUcPddZVBYRdGB2PSWgWaqA,3974
+archae-2026.2.0b1.dist-info/WHEEL,sha256=fAguSjoiATBe7TNBkJwOjyL1Tt4wwiaQGtNtjRPNMQA,80
+archae-2026.2.0b1.dist-info/entry_points.txt,sha256=gGL_R78QELaTeyFGb-OuSnRuu4EUdT68EKmyrFno59o,48
+archae-2026.2.0b1.dist-info/METADATA,sha256=NiFftqzt93bRJoLbDw7jpWo5-Xt8JclNlSk8SezrroE,7976
+archae-2026.2.0b1.dist-info/RECORD,,

archae-2026.1.0b2.dist-info/RECORD

@@ -1,16 +0,0 @@
-archae/__init__.py,sha256=tqGdU1tlaD9BIf9_PfhiMRLVsoqTTHr9JIJq7jht1ys,32
-archae/__main__.py,sha256=l3eO5dEs1cR_hDziOpnW1PYzoRL2siYm81wgvftyigg,172
-archae/cli.py,sha256=oUu8PwNMU6stvwIFOmV74lhhrasXvHxPwsbbplcRK1s,12402
-archae/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-archae/util/__init__.py,sha256=HlENK1XfnwnYMrlkvVJTjs-6W7RLLUJOoyFcOb7njUE,34
-archae/util/archiver/__init__.py,sha256=baayr_wh2MfRaKKiVuaUxtYJcMzKR82Uf1amcU7QtzM,202
-archae/util/archiver/base_archiver.py,sha256=_2-ARZLxPqSeE_0TF7NTVK8TwWhLyP9fA2G0fnMb0zc,1549
-archae/util/archiver/peazip.py,sha256=XdhI2EQ3A9EH89KxPv-FcmjukwWcS96WtG-gwkha6hs,4022
-archae/util/archiver/seven_zip.py,sha256=eck_cXMGFqwJ05ZKge3N0Ozy1XkKuGyE09s3jFcsMrQ,4951
-archae/util/archiver/unar.py,sha256=xWTR7cpFXyofvtPI-7Z5Ski605WmJdLoAm6a81IriAc,3974
-archae/util/enum/__init__.py,sha256=IvjtVopATKLAHDjOpblaExy2yXwIzweX0HoUrQWcpkM,109
-archae/util/enum/byte_scale.py,sha256=5TZG1msPmJU9whZtKAywZtKOre6p2xMJ2y0gE4TG3OE,1593
-archae-2026.1.0b2.dist-info/WHEEL,sha256=fAguSjoiATBe7TNBkJwOjyL1Tt4wwiaQGtNtjRPNMQA,80
-archae-2026.1.0b2.dist-info/entry_points.txt,sha256=gGL_R78QELaTeyFGb-OuSnRuu4EUdT68EKmyrFno59o,48
-archae-2026.1.0b2.dist-info/METADATA,sha256=csePSw_sY2L6Obx276UqN-05kpdqOedEh7zDbrkA3-o,8477
-archae-2026.1.0b2.dist-info/RECORD,,