# Development

## Setup

```bash
git clone https://github.com/GRodolphe/Anubis && cd Anubis
uv sync
```

This installs the package in editable mode plus the dev tools: `ruff`, `ty`, and `Cython`.

## Project layout

```
src/anubis/
  __init__.py       # package marker, __version__
  __main__.py       # enables python -m anubis
  cli.py            # argparse entry point + interactive mode
  config.py         # anubis.toml loader (load_config)
  obfuscators.py    # all obfuscation passes
  crypto.py         # AES encryption (Encryption class)
  terminal.py       # ANSI colour helpers, is_ci, clear/pause/leave/error
ancrypt.py          # Cython source for the AES runtime loader
setup.py            # build ancrypt extension only
pyproject.toml      # project metadata, ruff, ty config
anubis.toml         # optional: pin obfuscation flags (see CI/CD Mode)
tests/
  test_terminal.py  # unit tests for is_ci() and CI-safe helpers
  test_config.py    # unit tests for anubis.toml loader
  test_cli.py       # integration tests for --ci and --output flags
.github/workflows/
  ci.yml            # lint + obfuscation matrix (Python 3.10–3.13)
  obfuscate.yml     # example: obfuscate a script as a CI job
.gitlab-ci.yml      # example: GitLab CI obfuscation job
gitbook/            # documentation source (this site)
```

## Lint

```bash
uv run ruff check src/
uv run ruff format src/
```

## Type check

```bash
uv run ty check src/
```

## Running tests locally

```bash
# Single test
bash tests/check_obf.sh tests/scripts/test_math.py --carbon --junk

# All combinations (mirrors CI)
for f in tests/scripts/*.py; do
  bash tests/check_obf.sh "$f" --carbon --junk --mix-strings
done
```

## Building ancrypt

```bash
uv run --group dev python setup.py build_ext --inplace
```

## Adding a new obfuscation pass

1. Implement the pass as a function in `src/anubis/obfuscators.py` with signature `def my_pass(code: str) -> str`.
2. Import it in `src/anubis/cli.py`.
3. Add a `--my-pass` flag to `_build_parser()`.
4. Insert the call at the right point in `_run_pipeline()`.
5. Add the flag to the interactive prompts in `_interactive()`.
6. Write a test script in `tests/scripts/` and add steps to `tests/check_obf.sh` / `.github/workflows/ci.yml`.

## Releasing

1. Bump `version` in `pyproject.toml` and `src/anubis/__init__.py`.
2. Push to `main` CI must pass.
3. Tag the commit: `git tag vX.Y.Z && git push --tags`.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://rodolphes-organization.gitbook.io/anubis/development.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.