extirpation
A Python plugin-style library that auto-loads encryption modules from an online/ folder.
Highlights
- Drop-in modules: add a
.pyfile toonline/and it loads automatically. - Recursive discovery for nested module folders.
- Structured load reports with per-module errors.
- Built-in CLI for discovery, diagnostics, capability signatures, version checks, and direct function invocation.
- GitHub Actions CI + automated PyPI publishing on GitHub Release.
Install
pip install extirpation
For local development:
pip install -e .[dev]
Python API
Quick start (new users)
from extirpation import quick_transform
ciphertext = quick_transform("caesar", "encrypt", "HELLO", params={"shift": 3})
plaintext = quick_transform("caesar", "decrypt", ciphertext, params={"shift": 3})
print(ciphertext, plaintext) # KHOOR HELLO
The first call auto-provisions bundled modules into ./online if needed, then runs the matching cipher function.
Full API
from extirpation import (
ensure_online_modules,
list_online_modules,
load_online_modules,
load_online_modules_with_report,
quick_transform,
setup,
)
modules = ensure_online_modules("online")
print(quick_transform("caesar", "encrypt", "HELLO", params={"shift": 3}))
print(list_online_modules("online"))
modules = load_online_modules("online")
print(modules["caesar"].encrypt("HELLO", shift=3))
report = load_online_modules_with_report("online", recursive=True)
print(report.modules.keys())
print(report.errors)
setup_result = setup("online")
print(len(setup_result.copied), len(setup_result.skipped))
CLI
List modules:
extirpation --online-dir online list
List modules as JSON:
extirpation --online-dir online list --json
Generate JSON load report:
extirpation --online-dir online --recursive --workers 4 report
Use cache for faster repeated inspection commands:
extirpation --online-dir online --cache catalog
Use cache for module listing too:
extirpation --online-dir online --cache list --json
Print installed version:
extirpation version
Invoke a function directly:
extirpation --online-dir online invoke --module caesar --function caesar_encrypt --kwargs "{\"plaintext\":\"HELLO\",\"shift\":3}"
Run a simple encrypt/decrypt flow without knowing exact function names:
extirpation --online-dir online transform --module caesar --mode encrypt --text "HELLO" --params "{\"shift\":3}"
Invoke multiple functions in one call:
extirpation --online-dir online invoke-batch --calls "[{\"module\":\"caesar\",\"function\":\"caesar_encrypt\",\"kwargs\":{\"plaintext\":\"ABC\",\"shift\":3}}]"
Continue batch execution even when one call fails (default), or stop immediately:
extirpation --online-dir online invoke-batch --stop-on-error --calls "[...]"
Show aggregate stats:
extirpation --online-dir online stats
Run a quick health check:
extirpation --online-dir online doctor
Fail CI when health issues are found:
extirpation --online-dir online doctor --fail-on-issues
Clear in-memory cache:
extirpation clear-cache
Benchmark load performance:
extirpation --online-dir online --cache --workers 4 benchmark --iterations 5
Search catalog for matching modules/functions:
extirpation --online-dir online find --query caesar
Inspect one module:
extirpation --online-dir online inspect --module caesar
Validate module contracts:
extirpation --online-dir online validate
Scaffold a new module template:
extirpation --online-dir online scaffold my_new_cipher
Provision bundled modules into your target folder:
extirpation --online-dir online setup
If you're installed from PyPI, setup now provisions modules from package-bundled files.
Export catalog to Markdown:
extirpation --online-dir online export-catalog --format markdown --output docs/catalog.md
Wordlists
The repository now includes starter multilingual wordlists under online/wordlist/.
- Latin alphabet languages:
online/wordlist/latin/*.txt - Non-Latin languages are grouped by script/alphabet:
- Cyrillic:
online/wordlist/cyrillic/*.txt - Greek:
online/wordlist/greek/*.txt - Arabic:
online/wordlist/arabic/*.txt - Devanagari:
online/wordlist/devanagari/*.txt
- Cyrillic:
All files are UTF-8 and use one word per line.
Included modules
(Alphabetical, 104 modules)
online/a1z26.pyonline/adfgvx.pyonline/adfgx.pyonline/affine.pyonline/affine_progressive.pyonline/alphabet_filter.pyonline/amsco_transposition.pyonline/atbash.pyonline/autokey.pyonline/baconian.pyonline/base32_cipher.pyonline/base64_cipher.pyonline/beaufort.pyonline/beaufort_autokey.pyonline/bifid.pyonline/binary_cipher.pyonline/braille_unicode.pyonline/caesar.pyonline/caesar_autoshift.pyonline/caesar_box.pyonline/caesar_prime.pyonline/caesar_progressive.pyonline/chaocipher.pyonline/checkerboard_straddling.pyonline/chunk_swap.pyonline/columnar_snake.pyonline/columnar_transposition.pyonline/diagonal_zigzag.pyonline/disrupted_transposition.pyonline/double_transposition.pyonline/enigma.py(full Enigma simulation)online/feistel_toy.pyonline/fibonacci_caesar.pyonline/fibonacci_shift.pyonline/four_square.pyonline/fractionated_morse.pyonline/general_rot_n_with_custom_alphabet.pyonline/gronsfeld.pyonline/hex_cipher.pyonline/hill_cipher.pyonline/jefferson_disk.pyonline/keyboard_shift.pyonline/keyword_caesar.pyonline/keyword_substitution.pyonline/langcheck.pyonline/leetspeak.pyonline/lfsr_toy.pyonline/mirror_chunks.pyonline/morse.pyonline/multiplicative_cipher.pyonline/myszkowski_transposition.pyonline/nato_phonetic.pyonline/nihilist_substitution.pyonline/null_cipher.pyonline/null_cipher_word_mode.pyonline/one_time_pad.pyonline/paired_caesar.pyonline/paired_vigenere.pyonline/permutation_blocks.pyonline/pig_latin.pyonline/pigpen.pyonline/playfair.pyonline/polyalpha_cycle.pyonline/polybius.pyonline/porta.pyonline/quagmire_i.pyonline/quagmire_ii.pyonline/quagmire_iii.pyonline/quagmire_iv.pyonline/rail_fence.pyonline/rail_fence_offset.pyonline/rail_fence_variable.pyonline/reverse_caesar.pyonline/reverse_cipher.pyonline/reverse_words.pyonline/rot13.pyonline/rot18.pyonline/rot47.pyonline/rot5.pyonline/rot_n.pyonline/rotating_caesar.pyonline/route_boustrophedon.pyonline/route_cipher.pyonline/route_columns_reverse.pyonline/route_diagonal.pyonline/running_key.pyonline/scytale.pyonline/spiral_route.pyonline/spn_toy.pyonline/substitution_monoalpha.pyonline/tap_code.pyonline/transpose_blocks.pyonline/trifid.pyonline/trinary_cipher.pyonline/triple_caesar.pyonline/trithemius.pyonline/two_square.pyonline/vernam.pyonline/vigenere.pyonline/vowel_shift.pyonline/word_caesar.pyonline/xor_base64.pyonline/xor_cipher.pyonline/zigzag_words.py
Automated PyPI publishing from GitHub Releases
This repo includes .github/workflows/publish-pypi.yml that publishes automatically when a GitHub Release is published.
One-time setup in PyPI
- Create the project (
extirpation) on PyPI (or use an existing one). - In PyPI, configure Trusted Publishing and add this GitHub repo/workflow.
- In GitHub, ensure the
publishjob can run withid-token: write(already configured).
Release flow
- Merge to your default branch.
- Create and publish a GitHub Release (for example tag
v2.6.11). - GitHub Actions runs tests (
ci.yml), builds distributions, validates them, and publishes to PyPI.
Local packaging checks
python -m build
python -m twine check dist/*
Metadata
Release files for extirpation 2.6.14
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| extirpation-2.6.14.tar.gz | 67.4 kB | With provenance | Details for extirpation-2.6.14.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| extirpation-2.6.14-py3-none-any.whl | Python 3 | none | any | Details for extirpation-2.6.14-py3-none-any.whl |
Total release size: 171.9 kB
Release files / extirpation-2.6.14.tar.gz
| Download URL | extirpation-2.6.14.tar.gz |
|---|---|
| Size | 67.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
4ae74c230998941aa2a09ce3af6468d2a2a0841d2357458b948482c2b9f91e75
|
|
BLAKE2b-256 checksum How to use checksums |
808d72fe2393d4cfa280eca27ffa1add6663cf37523cda73d94552924f9bb8e7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 15, 2026.
Transparency logRelease files / extirpation-2.6.14-py3-none-any.whl
| Download URL | extirpation-2.6.14-py3-none-any.whl |
|---|---|
| Size | 104.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
34950bd43e42e37cc939fadfde21f1e9520af5f748f254bc70543e5f16e944fc
|
|
BLAKE2b-256 checksum How to use checksums |
166468984a12bb29e4652ddca6d5bc97a9c3960dc3ae5f0e2749b0e88a31be50
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.12
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 15, 2026.
Transparency logSecurity for extirpation 2.6.14
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for extirpation-2.6.14.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Apr 15, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.