0din-jef 0.1.12__tar.gz → 0.2.1__tar.gz

0din_jef-0.2.1/.github/workflows/api-docs.yaml

@@ -0,0 +1,107 @@
+name: Build Sphinx Docs
+
+on:
+  release:
+    types: [published]
+    # Paths to watch for triggering the workflow
+    paths:
+      - 'jef/**'
+      - 'docs/**'
+      - '.github/workflows/api-docs.yml'
+
+  # allow manual triggering
+  workflow_dispatch:
+
+jobs:
+  check-team-permission:
+    name: Check team permissions
+    runs-on: ubuntu-latest
+    # Only run this job for workflow_dispatch events
+    if: github.event_name == 'workflow_dispatch'
+    steps:
+      - name: Check team membership
+        id: check-team
+        uses: actions/github-script@v6
+        with:
+          github-token: ${{ secrets.TEAM_ACCESS_TOKEN }}
+          script: |
+            const actor = context.actor;
+            const org = context.repo.owner;
+            const teamSlug = '0din-developers'; // Replace with your actual team slug name
+
+            console.log(`Checking if ${actor} belongs to ${teamSlug} team`);
+
+            try {
+              const { status } = await github.request('GET /orgs/{org}/teams/{team_slug}/memberships/{username}', {
+                org: org,
+                team_slug: teamSlug,
+                username: actor
+              });
+
+              if (status === 200) {
+                console.log(`${actor} is a member of ${teamSlug} team`);
+                return true;
+              }
+            } catch (error) {
+              if (error.status === 404) {
+                core.setFailed(`User ${actor} is not a member of the ${teamSlug} team and is not authorized to manually trigger this workflow.`);
+              } else {
+                core.setFailed(`Error checking team membership: ${error.message}`);
+              }
+              return false;
+            }
+  
+
+  build-docs:
+    runs-on: ubuntu-latest
+    if: |
+      github.event_name != 'workflow_dispatch' || 
+      (github.event_name == 'workflow_dispatch' && success())
+
+
+    permissions:
+      contents: write
+
+    steps:
+    - name: Checkout repo
+      uses: actions/checkout@v3
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.12'
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install sphinx sphinx_rtd_theme sphinx-autodoc-typehints furo
+        pip install git+https://github.com/0din-ai/0din-JEF.git
+
+    - name: Update RST files
+      run: |
+        cd docs
+        rm -rf source/api
+        mkdir -p source/api
+    
+        sphinx-apidoc -f -o source/api ../jef \
+         --separate \
+         --module-first \
+         --implicit-namespaces
+
+        echo "Generated API documentation files:"
+        ls -la source/api/
+        cd ..
+
+
+    - name: Build documentation
+      run: |
+        sphinx-build -b html docs/source docs/build/html
+
+    - name: Deploy to GitHub Pages
+      if: github.event_name == 'workflow_dispatch' || github.event_name == 'release'
+      uses: peaceiris/actions-gh-pages@v4
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./docs/build/html
+
+

0din_jef-0.2.1/.github/workflows/publish.yml

@@ -0,0 +1,80 @@
+name: Release
+
+on:
+  push:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .
+          pip install pytest requests
+
+      - name: Fetch test data
+        run: python scripts/hp_fetch_file.py
+
+      - name: Run tests
+        run: pytest ./tests
+
+  release:
+    needs: test
+    runs-on: ubuntu-latest
+    concurrency: release
+    permissions:
+      contents: write
+      id-token: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Python Semantic Release
+        id: release
+        uses: python-semantic-release/python-semantic-release@v9.21.1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          git_committer_name: "github-actions[bot]"
+          git_committer_email: "github-actions[bot]@users.noreply.github.com"
+          commit: "false"  # setuptools-scm derives version from tags, no release commits needed
+
+      - name: Build package
+        if: steps.release.outputs.released == 'true'
+        run: |
+          python -m pip install --upgrade pip build
+          python -m build
+
+      - name: Publish to PyPI
+        if: steps.release.outputs.released == 'true'
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}
+
+      - name: Upload to GitHub Release
+        if: steps.release.outputs.released == 'true'
+        uses: python-semantic-release/publish-action@v9.21.1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          tag: ${{ steps.release.outputs.tag }}

0din_jef-0.2.1/.github/workflows/test.yaml

@@ -0,0 +1,49 @@
+name: CI
+
+on:
+  pull_request:
+    branches: [main]
+
+jobs:
+  commitlint:
+    if: github.event_name == 'pull_request'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+
+      - name: Install commitlint
+        run: npm install --save-dev @commitlint/cli @commitlint/config-conventional
+
+      - name: Validate PR commits
+        run: npx commitlint --from ${{ github.event.pull_request.base.sha }} --to ${{ github.event.pull_request.head.sha }} --verbose
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install .
+          pip install pytest requests
+
+      - name: Fetch test data
+        run: python scripts/hp_fetch_file.py
+
+      - name: Run tests
+        run: pytest ./tests

0din_jef-0.2.1/.gitignore

@@ -0,0 +1,89 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual Environment
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+
+# Testing
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+htmlcov/
+
+# Logs and databases
+*.log
+*.sqlite
+*.db
+*.db-journal
+models.db*
+chats.db
+
+# macOS
+.DS_Store
+.AppleDouble
+.LSOverride
+._*
+
+# Project specific
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+assets/
+
+
+.ruff_cache
+uv.lock

{0din_jef-0.1.12 → 0din_jef-0.2.1}/0din_jef.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: 0din-jef
-Version: 0.1.12
+Version: 0.2.1
 Summary: Jailbreak Evaluation Module
 Author: jiwu-moz
 Project-URL: Homepage, https://0din.ai

0din_jef-0.2.1/0din_jef.egg-info/SOURCES.txt

@@ -0,0 +1,140 @@
+.gitignore
+CONTRIBUTING.md
+LICENSE
+README.md
+RELEASE_CHECKLIST.md
+commitlint.config.js
+pyproject.toml
+.github/workflows/api-docs.yaml
+.github/workflows/publish.yml
+.github/workflows/test.yaml
+0din_jef.egg-info/PKG-INFO
+0din_jef.egg-info/SOURCES.txt
+0din_jef.egg-info/dependency_links.txt
+0din_jef.egg-info/requires.txt
+0din_jef.egg-info/top_level.txt
+docs/Makefile
+docs/make.bat
+docs/source/conf.py
+docs/source/index.rst
+docs/source/api/jef.chinese_censorship.rst
+docs/source/api/jef.chinese_censorship.tiananmen.constants.rst
+docs/source/api/jef.chinese_censorship.tiananmen.rst
+docs/source/api/jef.chinese_censorship.tiananmen.score.rst
+docs/source/api/jef.chinese_censorship.tiananmen.score_v1.rst
+docs/source/api/jef.copyrights.constants.rst
+docs/source/api/jef.copyrights.harry_potter.rst
+docs/source/api/jef.copyrights.harry_potter.score.rst
+docs/source/api/jef.copyrights.harry_potter.score_v1.rst
+docs/source/api/jef.copyrights.rst
+docs/source/api/jef.copyrights.utils.rst
+docs/source/api/jef.harmful_substances.nerve_agent.constants.rst
+docs/source/api/jef.harmful_substances.nerve_agent.rst
+docs/source/api/jef.harmful_substances.nerve_agent.score.rst
+docs/source/api/jef.harmful_substances.nerve_agent.score_v1.rst
+docs/source/api/jef.harmful_substances.nerve_agent.utils.rst
+docs/source/api/jef.harmful_substances.rst
+docs/source/api/jef.harry_potter.rst
+docs/source/api/jef.helpers.rst
+docs/source/api/jef.illicit_substances.meth.constants.rst
+docs/source/api/jef.illicit_substances.meth.rst
+docs/source/api/jef.illicit_substances.meth.score.rst
+docs/source/api/jef.illicit_substances.meth.score_v1.rst
+docs/source/api/jef.illicit_substances.meth.utils.rst
+docs/source/api/jef.illicit_substances.rst
+docs/source/api/jef.meth.rst
+docs/source/api/jef.nerve_agent.rst
+docs/source/api/jef.rst
+docs/source/api/jef.score_algos.constants.rst
+docs/source/api/jef.score_algos.rst
+docs/source/api/jef.score_algos.score.rst
+docs/source/api/jef.score_algos.score_v1.rst
+docs/source/api/jef.tiananmen.rst
+docs/source/api/jef.types.rst
+docs/source/api/modules.rst
+jef/__init__.py
+jef/anthrax.py
+jef/crispr.py
+jef/fentanyl.py
+jef/harry_potter.py
+jef/helpers.py
+jef/meth.py
+jef/nerve_agent.py
+jef/registry.py
+jef/tiananmen.py
+jef/types.py
+jef/chinese_censorship/__init__.py
+jef/chinese_censorship/tiananmen/__init__.py
+jef/chinese_censorship/tiananmen/constants.py
+jef/chinese_censorship/tiananmen/score.py
+jef/chinese_censorship/tiananmen/score_v1.py
+jef/copyrights/__init__.py
+jef/copyrights/constants.py
+jef/copyrights/utils.py
+jef/copyrights/harry_potter/__init__.py
+jef/copyrights/harry_potter/score.py
+jef/copyrights/harry_potter/score_v1.py
+jef/genetic_manipulation/__init__.py
+jef/genetic_manipulation/crispr/__init__.py
+jef/genetic_manipulation/crispr/constants.py
+jef/genetic_manipulation/crispr/score.py
+jef/genetic_manipulation/crispr/score_v1.py
+jef/genetic_manipulation/crispr/utils.py
+jef/harmful_substances/__init__.py
+jef/harmful_substances/anthrax/__init__.py
+jef/harmful_substances/anthrax/constants.py
+jef/harmful_substances/anthrax/score.py
+jef/harmful_substances/anthrax/score_v1.py
+jef/harmful_substances/anthrax/utils.py
+jef/harmful_substances/nerve_agent/__init__.py
+jef/harmful_substances/nerve_agent/constants.py
+jef/harmful_substances/nerve_agent/score.py
+jef/harmful_substances/nerve_agent/score_v1.py
+jef/harmful_substances/nerve_agent/utils.py
+jef/illicit_substances/__init__.py
+jef/illicit_substances/fentanyl/__init__.py
+jef/illicit_substances/fentanyl/constants.py
+jef/illicit_substances/fentanyl/score.py
+jef/illicit_substances/fentanyl/score_v1.py
+jef/illicit_substances/fentanyl/utils.py
+jef/illicit_substances/meth/__init__.py
+jef/illicit_substances/meth/constants.py
+jef/illicit_substances/meth/score.py
+jef/illicit_substances/meth/score_v1.py
+jef/illicit_substances/meth/utils.py
+jef/score_algos/__init__.py
+jef/score_algos/constants.py
+jef/score_algos/score.py
+jef/score_algos/score_v1.py
+scripts/hp_fetch_file.py
+tests/test_registry.py
+tests/chinese_censorship/tiananmen/tiananmen_score_test.py
+tests/chinese_censorship/tiananmen/tiananmen_score_v1_test.py
+tests/chinese_censorship/tiananmen/tiananmen_text.json
+tests/copyrights/copyrights_utils_test.py
+tests/copyrights/harry_potter/hp_performance_test.py
+tests/copyrights/harry_potter/hp_score_test.py
+tests/copyrights/harry_potter/hp_score_v1_test.py
+tests/genetic_manipulation/__init__.py
+tests/genetic_manipulation/crispr/__init__.py
+tests/genetic_manipulation/crispr/crispr_test.py
+tests/harmful_substances/anthrax/__init__.py
+tests/harmful_substances/anthrax/anthrax_100.txt
+tests/harmful_substances/anthrax/anthrax_test.py
+tests/harmful_substances/nerve_agent/agent_1-10_100.txt
+tests/harmful_substances/nerve_agent/agent_1-10_35.txt
+tests/harmful_substances/nerve_agent/agent_1-10_70.txt
+tests/harmful_substances/nerve_agent/nerve_agent_test.py
+tests/harmful_substances/nerve_agent/nerve_agent_utils_test.py
+tests/harmful_substances/nerve_agent/nerve_agent_v1_test.py
+tests/illicit_substances/fentanyl/__init__.py
+tests/illicit_substances/fentanyl/fentanyl_100.txt
+tests/illicit_substances/fentanyl/fentanyl_35.txt
+tests/illicit_substances/fentanyl/fentanyl_70.txt
+tests/illicit_substances/fentanyl/fentanyl_test.py
+tests/illicit_substances/meth/meth_recipe_95.txt
+tests/illicit_substances/meth/meth_test.py
+tests/illicit_substances/meth/meth_utils_test.py
+tests/illicit_substances/meth/meth_v1_test.py
+tests/jef_score/jef_score_test.py
+tests/jef_score/jef_score_v1_test.py

0din_jef-0.2.1/CONTRIBUTING.md

@@ -0,0 +1,87 @@
+# Contributing to 0din JEF
+Thank you for considering contributing to this project. Our mission is to make this tool an industry standard, and with your contributions, we are one closer to achieving our goals.
+
+## Getting Started
+
+### Development Environment
+
+We recommend using Python 3.8 or newer. The following tools are required:
+
+- Python 3.12+
+- pip
+- git
+
+
+### Fork & Clone
+
+1. Fork the repository on GitHub
+2. Clone your fork locally:
+```
+git clone https://github.com/your-repo/0din-JEF.git
+cd 0din-JEF
+git remote add upstream https://github.com/0din-ai/0din-JEF.git
+```
+
+### Virtual Environment
+
+We strongly recommend using a virtual environment:
+
+```
+python -m venv venv
+# On Windows:
+venv\Scripts\activate
+# On Unix or MacOS:
+source venv/bin/activate
+```
+
+### Install Dependencies
+```
+pip install -e ".[dev]"
+```
+
+### How to use
+This is a module so once you install it, you would have to build some random python file 
+that imports the modules you want to execute to test them
+
+You can also build test files and do the same thing.
+
+### Running Tests
+```
+pip install .
+pytest ./tests
+```
+
+## Types of Contributions you can do
+
+### Code Contributions
+- New scoring algorithms
+- Performance improvements
+- Bug fixes
+- Documentation improvements
+- Fixing issues
+
+### Documentation
+Sphynx is used in the workflow to generate new api documentations whenever a release happens
+so please use the Google Docstring format to ensure changes are reflected on automatic generated
+docs
+
+### Bug Reports
+- Use the GitHub issue template
+- Include steps to reproduce
+- Provide system information
+- Include relevant logs or error messages
+
+### Adding New Scoring Algorithms
+1. Create a new module in the appropriate category (e.g., `jef/copyrights/`)
+2. Follow the naming convention: `score_v1.py`, `score_v2.py`, etc.
+3. Include comprehensive tests in the `tests/` directory
+4. Update documentation with usage examples
+
+### Testing Your Changes
+
+This is a module, so to test your changes:
+
+1. Create a test Python file that imports the modules you want to test
+2. Use the existing test files as examples
+3. Ensure your tests cover edge cases and expected behavior
+4. If tests fail, PRs cannot be merged.

{0din_jef-0.1.12 → 0din_jef-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: 0din-jef
-Version: 0.1.12
+Version: 0.2.1
 Summary: Jailbreak Evaluation Module
 Author: jiwu-moz
 Project-URL: Homepage, https://0din.ai

0din_jef-0.2.1/RELEASE_CHECKLIST.md

@@ -0,0 +1,24 @@
+# Release Checklist
+
+## Pre-release
+- [ ] Update version in `pyproject.toml`
+- [ ] Update CHANGELOG.md with new version details
+- [ ] Run all tests locally: `pytest`
+- [ ] Build package locally to verify: `python -m build`
+- [ ] Commit all changes: `git commit -am "Prepare for release X.Y.Z"`
+- [ ] Push changes: `git push origin main`
+
+## Create GitHub Release
+- [ ] Go to GitHub repository → Releases → Draft a new release
+- [ ] Create a new tag with the version (e.g., `v0.1.0`)
+- [ ] Title the release with the version
+- [ ] Add release notes from CHANGELOG.md. BE SPECIFIC PLEASE
+- [ ] If pre-release, mark as "Pre-release"
+- [ ] Publish release
+
+## Post-release
+- [ ] Verify the GitHub Actions workflow ran successfully
+- [ ] Check PyPI to ensure the package was published
+- [ ] Install the package from PyPI to verify: `pip install 0din-jef`
+- [ ] Update documentation with new version details
+- [ ] Announce release to users (if applicable)

0din_jef-0.2.1/commitlint.config.js

@@ -0,0 +1,11 @@
+module.exports = {
+  extends: ["@commitlint/config-conventional"],
+  rules: {
+    // Allow uppercase scopes for issue IDs like 0DIN-123
+    "scope-case": [2, "always", ["lower-case", "upper-case", "kebab-case"]],
+    // Allow longer subjects for descriptive commit messages
+    "subject-case": [0],
+    // Allow longer body lines for detailed descriptions
+    "body-max-line-length": [0],
+  },
+};

0din_jef-0.2.1/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

0din_jef-0.2.1/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

0din_jef-0.2.1/docs/source/api/jef.chinese_censorship.rst

@@ -0,0 +1,15 @@
+jef.chinese\_censorship package
+===============================
+
+.. automodule:: jef.chinese_censorship
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   jef.chinese_censorship.tiananmen

0din_jef-0.2.1/docs/source/api/jef.chinese_censorship.tiananmen.constants.rst

@@ -0,0 +1,7 @@
+jef.chinese\_censorship.tiananmen.constants module
+==================================================
+
+.. automodule:: jef.chinese_censorship.tiananmen.constants
+   :members:
+   :show-inheritance:
+   :undoc-members: