chbshash 0.1.0__tar.gz

chbshash-0.1.0/.dprint.jsonc

@@ -0,0 +1,35 @@
+{
+  "json": {
+    "lineWidth": 88,
+    "array.preferSingleLine": true,
+  },
+  "markdown": {
+    "lineWidth": 88,
+    "emphasisKind": "asterisks",
+  },
+  "markup": {
+    "printWidth": 88,
+  },
+  "toml": {
+    "lineWidth": 88,
+  },
+  "yaml": {
+    "printWidth": 88,
+    "formatComments": true,
+    "braceSpacing": false,
+  },
+  "excludes": [
+    "**/*-lock.json",
+    "**/*.lock",
+    "**/node_modules/",
+    "dist/",
+    "doc/requirements.yml",
+  ],
+  "plugins": [
+    "https://plugins.dprint.dev/g-plane/pretty_yaml-v0.5.1.wasm",
+    "https://plugins.dprint.dev/json-0.20.0.wasm",
+    "https://plugins.dprint.dev/markdown-0.19.0.wasm",
+    "https://plugins.dprint.dev/toml-0.7.0.wasm",
+    "https://plugins.dprint.dev/g-plane/markup_fmt-v0.22.0.wasm",
+  ],
+}

chbshash-0.1.0/.gitattributes

@@ -0,0 +1,4 @@
+# SCM syntax highlighting & preventing 3-way merges
+pixi.lock merge=binary linguist-language=YAML linguist-generated=true
+# reduce the number of merge conflicts
+doc/whats-new.rst merge=union

chbshash-0.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,2 @@
+- [ ] Closes #xxxx
+- [ ] Tests added / passed

chbshash-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,38 @@
+name: Documentation
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: ["*"]
+
+defaults:
+  run:
+    shell: bash -l {0}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - uses: prefix-dev/setup-pixi@v0
+        with:
+          pixi-version: v0.66.0
+          cache: true
+          environments: docs
+
+      - name: Regenerate readthedocs environment
+        run: pixi run doc-requirements
+
+      - name: Check that readthedocs environment is up to date in git
+        run: git diff --exit-code doc/requirements.yml
+
+      - name: Build docs
+        run: pixi run -e docs docs
+
+      - uses: actions/upload-artifact@v7
+        with:
+          name: chbshash-docs
+          path: build/html

chbshash-0.1.0/.github/workflows/lint.yml

@@ -0,0 +1,22 @@
+name: Linting
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: ["*"]
+
+jobs:
+  checks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: prefix-dev/setup-pixi@v0
+        with:
+          pixi-version: v0.66.0
+          cache: true
+          environments: lint
+      - name: Run linters
+        run: pixi run lint
+      - name: Check for changed files after linting
+        run: git diff --exit-code

chbshash-0.1.0/.github/workflows/pytest.yml

@@ -0,0 +1,66 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: ["*"]
+  workflow_dispatch: # allows you to trigger manually
+
+# When this workflow is queued, automatically cancel any previous running
+# or pending jobs from the same branch
+concurrency:
+  group: pytest-${{ github.ref }}
+  cancel-in-progress: true
+
+defaults:
+  run:
+    shell: bash -l {0}
+
+jobs:
+  test:
+    name: ${{ matrix.os }} ${{ matrix.environment }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        # Note: this project relies on random.Random() to produce stable outputs across
+        # platforms and Python versions. The test suite verifies this; this is why the
+        # matrix is so thorough. Also, hhash and chbssum feature OS-specific newline
+        # handling.
+        os:
+          - ubuntu-latest # x86-64
+          - ubuntu-24.04-arm # ARM
+          - macos-15-intel # x86-64
+          - macos-latest # ARM
+          - windows-latest # x86-64
+        environment: [smoke, mindeps, py314]
+        include:
+          - os: ubuntu-latest
+            environment: nogil
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - uses: prefix-dev/setup-pixi@v0
+        with:
+          pixi-version: v0.66.0
+          environments: ${{ matrix.environment }}
+          cache: true
+          locked: true
+
+      - name: Smoke test
+        run: pixi run -e ${{ matrix.environment }} smoke-test
+
+      - name: pytest with coverage
+        if: matrix.environment != 'smoke'
+        run: pixi run -e ${{ matrix.environment }} coverage
+
+      - name: Free-threading stress test
+        if: matrix.environment == 'nogil'
+        run: pixi run -e nogil tests --parallel-threads=4
+
+      - name: codecov.io
+        if: matrix.environment != 'smoke'
+        uses: codecov/codecov-action@v5

chbshash-0.1.0/.github/workflows/wheels.yml

@@ -0,0 +1,55 @@
+name: Wheels
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: ["*"]
+
+defaults:
+  run:
+    shell: bash -l {0}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0 # Fetch full git history for hatch-vcs
+          fetch-tags: true # Fetch tags for hatch-vcs
+
+      - uses: prefix-dev/setup-pixi@v0
+        with:
+          pixi-version: v0.66.0
+          cache: true
+          environments: dist
+
+      - name: Build sdist and wheels
+        run: pixi run dist
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.14"
+
+      - name: Install wheel
+        run: pip install dist/*.whl
+
+      - name: Smoke test
+        working-directory: /tmp
+        run: |
+          cp ${{ github.workspace }}/smoke_test.py .
+          python smoke_test.py
+
+      - name: CLI smoke test (chbs)
+        run: chbs
+      - name: CLI smoke test (chbssum)
+        run: echo "hello world" | chbssum
+
+      - uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/*
+          if-no-files-found: error

chbshash-0.1.0/.gitignore

@@ -0,0 +1,67 @@
+# pixi environments
+.pixi/*
+!.pixi/config.toml
+
+*.pyc
+__pycache__
+
+# C extensions
+*.so
+
+# Packages
+*.egg
+*.egg-info
+.eggs
+dist
+build
+eggs
+parts
+var
+sdist
+develop-eggs
+.installed.cfg
+lib
+lib64
+
+# Installer logs
+pip-log.txt
+
+# Unit test / coverage reports
+.coverage*
+coverage.xml
+.tox
+nosetests.xml
+.cache
+.mypy_cache/
+.ropeproject/
+.tags*
+.testmon*
+.pytest_cache
+dask-worker-space/
+
+# asv environments
+.asv
+
+# Translations
+*.mo
+
+# Mr Developer
+.mr.developer.cfg
+.project
+.pydevproject
+
+# IDEs
+.idea
+*.swp
+.DS_Store
+.vscode/
+
+# Sync tools
+Icon*
+
+.ipynb_checkpoints
+
+doc/_build
+Untitled.ipynb
+htmlcov/
+.~lock.*

chbshash-0.1.0/.readthedocs.yaml

@@ -0,0 +1,20 @@
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: mambaforge-22.9
+
+conda:
+  environment: doc/requirements.yml
+
+python:
+  install:
+    - method: pip
+      path: .
+
+sphinx:
+  builder: html
+  configuration: doc/conf.py
+  # This is deliberately laxer than the setting in CI
+  fail_on_warning: false

chbshash-0.1.0/HOW_TO_RELEASE

@@ -0,0 +1,62 @@
+How to issue a release in 15 easy steps
+
+Time required: about an hour.
+
+ 1. Ensure your main branch is synced to origin:
+       git pull origin main
+ 2. Look over whats-new.rst and the docs. Make sure "What's New" is complete
+    (check the date!) and add a brief summary note describing the release at the
+    top.
+ 3. If you have any doubts, run the full test suite one final time!
+      pixi run tests
+ 4. On the main branch, commit the release in git:
+      git commit -a -m 'Release vX.Y.Z'
+ 5. Tag the release:
+      git tag -a vX.Y.Z -m 'vX.Y.Z'
+ 6. Push your changes to main:
+      git push origin main
+      git push origin --tags
+ 7. Update the stable branch (used by ReadTheDocs) and switch back to main:
+      git checkout stable
+      git rebase main
+      git push origin stable
+      git checkout main
+    It's OK to force push to 'stable' if necessary.
+    We also update the stable branch with `git cherrypick` for documentation
+    only fixes that apply the current released version.
+ 8. Build and test the release package
+      pixi run dist
+ 9. Add a section for the next release to doc/whats-new.rst.
+10. Commit your changes and push to main again:
+      git commit -a -m 'Revert to dev version'
+      git push origin main
+    You're done pushing to main!
+11. Issue the release on GitHub. Open https://github.com/crusaderky/chbshash/releases;
+    the new release should have automatically appeared. Otherwise, click on
+    "Draft a new release" and paste in the latest from whats-new.rst.
+12. Use twine to register and upload the release on pypi. Be careful, you can't
+    take this back!
+      pixi run twine-upload
+    You will need to be listed as a package owner at
+    https://pypi.python.org/pypi/chbshash for this to work.
+13. Update the docs. Login to https://readthedocs.org/projects/chbshash/versions/
+    and switch your new release tag (at the bottom) from "Inactive" to "Active".
+    It should now build automatically.
+    Make sure that both the new tagged version and 'stable' build successfully.
+14. Update conda-forge.
+14a.  Clone https://github.com/conda-forge/chbshash-feedstock
+14b.  Update the version number and sha256 in meta.yaml.
+      You can calculate sha256 with
+        sha256sum dist/*
+14c.  Double check dependencies in meta.yaml and update them to match pyproject.toml.
+14d.  Submit a pull request.
+14e.  Write a comment in the PR:
+        @conda-forge-admin, please rerender
+      Wait for the rerender commit (it may take a few minutes).
+14f.  Wait for CI to pass and merge.
+14g.  The next day, test the conda-forge release
+        conda search chbshash
+        conda create -n chbshash-test chbshash
+        conda activate chbshash-test
+        conda list
+        python -c 'import chbshash'

chbshash-0.1.0/LICENSE

@@ -0,0 +1,191 @@
+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:
+
+You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+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
+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.

chbshash-0.1.0/LICENSE.english-words.md

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
+OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
+ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.
+
+For more information, please refer to <https://unlicense.org/>

chbshash-0.1.0/MANIFEST.in

@@ -0,0 +1,11 @@
+include HOW_TO_RELEASE
+include LICENSE
+include *.md
+include *.py
+recursive-include doc *
+recursive-include chbshash *
+prune doc/_build
+global-exclude __pycache__
+global-exclude *.pyc
+global-exclude .DS_Store
+global-exclude .ipynb_checkpoints

chbshash-0.1.0/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.4
+Name: chbshash
+Version: 0.1.0
+Summary: XKCD's Correct Horse Battery Staple passphrase generator and hasher
+Project-URL: homepage, https://github.com/crusaderky/chbshash
+Project-URL: issues, https://github.com/crusaderky/chbshash/issues
+Project-URL: documentation, https://chbshash.readthedocs.io/
+Project-URL: changelog, https://chbshash.readthedocs.io/en/latest/whats-new.html
+Author-email: crusaderky <crusaderky@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: LICENSE.english-words.md
+Keywords: hash,password,xkcd
+Classifier: Development Status :: 3 - Alpha
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+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 :: Free Threading :: 4 - Resilient
+Classifier: Topic :: Security :: Cryptography
+Requires-Python: >=3.9
+Description-Content-Type: text/plain
+
+XKCD's Correct Horse Battery Staple passphrase generator and hasher

chbshash-0.1.0/README.md

@@ -0,0 +1,11 @@
+[![doc-badge](https://github.com/crusaderky/chbshash/actions/workflows/docs.yml/badge.svg)](https://github.com/crusaderky/chbshash/actions)
+[![lint-badge](https://github.com/crusaderky/chbshash/actions/workflows/lint.yml/badge.svg)](https://github.com/crusaderky/chbshash/actions)
+[![wheels-badge](https://github.com/crusaderky/chbshash/actions/workflows/wheels.yml/badge.svg)](https://github.com/crusaderky/chbshash/actions)
+[![pytest-badge](https://github.com/crusaderky/chbshash/actions/workflows/pytest.yml/badge.svg)](https://github.com/crusaderky/chbshash/actions)
+[![codecov-badge](https://codecov.io/gh/crusaderky/chbshash/branch/main/graph/badge.svg)](https://codecov.io/gh/crusaderky/chbshash/branch/main)
+
+# chbshash
+
+XKCD's *Correct Horse Battery Staple* passphrase generator and hasher
+
+Full documentation at http://chbshash.readthedocs.io/

chbshash-0.1.0/chbshash/__init__.py

@@ -0,0 +1,13 @@
+import importlib.metadata
+
+# Import implementation modules
+from chbshash.api import clear_cache, hash, random, words
+
+try:
+    __version__ = importlib.metadata.version("chbshash")
+except importlib.metadata.PackageNotFoundError:  # pragma: nocover
+    # Local copy, not installed with pip
+    __version__ = "9999"
+
+
+__all__ = ("__version__", "clear_cache", "hash", "random", "words")