sha256bit 0.2.3__tar.gz → 0.2.4__tar.gz

{sha256bit-0.2.3 → sha256bit-0.2.4}/.github/workflows/test.yml

@@ -39,7 +39,6 @@ jobs:
       run: |
         python -m pip install --upgrade pip
         python -m pip install hatch build
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
 
     - if: matrix.python-version == '3.12' && runner.os == 'Linux'
       name: Lint
@@ -52,6 +51,6 @@ jobs:
     - if: matrix.python-version == '3.12' && runner.os == 'Linux'
       name: Doc
       run: |
-        cd docs
-        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-        make clean doctest html
+        python -m pip install pipenv
+        pipenv install --deploy --system --dev
+        make -C docs clean doctest html

{sha256bit-0.2.3 → sha256bit-0.2.4}/.readthedocs.yaml

@@ -5,6 +5,17 @@
 # Required
 version: 2
 
+# Dependencies come from the root Pipfile.lock
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+  jobs:
+    post_create_environment:
+      - pip install pipenv
+    post_install:
+      - VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH pipenv install --deploy --dev
+
 # Build documentation in the docs/ directory with Sphinx
 sphinx:
   configuration: docs/source/conf.py
@@ -16,10 +27,4 @@ sphinx:
 # Optionally build your docs in additional formats such as PDF and ePub
 formats:
     - htmlzip
-    - pdf
-
-# Optionally set the version of Python and requirements required to build your docs
-python:
-  version: 3.12
-  install:
-    - requirements: docs/requirements.txt
+    - pdf

{sha256bit-0.2.3 → sha256bit-0.2.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: sha256bit
-Version: 0.2.3
+Version: 0.2.4
 Summary: SHA256/SHA224 with bit granularity for message input length
 Project-URL: Homepage, https://github.com/sebastien-riou/sha256bit
 Project-URL: Bug Tracker, https://github.com/sebastien-riou/sha256bit/issues
@@ -10,8 +10,6 @@ Classifier: Development Status :: 4 - Beta
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-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
@@ -38,7 +36,28 @@ Pure python implementation of SHA256 and SHA224 with features which are often la
 
 ## Installation
 
-    python3 -m pip install sha256bit
+### Command line tool
+Install with [pipx](https://pipx.pypa.io), it puts the `sha256bit` command in its own isolated environment:
+
+    pipx install sha256bit
+
+The message is given as a hex string:
+
+    $ sha256bit 616263
+    BA 78 16 BF 8F 01 CF EA 41 41 40 DE 5D AE 22 23 B0 03 61 A3 96 17 7A 9C B4 10 FF 61 F2 00 15 AD
+    $ sha256bit --algo sha224 616263
+    23 09 7D 22 34 05 D8 22 86 42 A4 77 BD A2 55 B3 2A AD BC E4 BD A0 B3 F7 E3 6C 9D A7
+    $ sha256bit --bit-length 1 00
+    BD 4F 9E 98 BE B6 8C 6E AD 32 43 B1 B4 C7 FE D7 5F A4 FE AA B1 F8 47 95 CB D8 A9 86 76 A2 A3 75
+
+If `pipx` is missing, on Debian/Ubuntu: `sudo apt install pipx && pipx ensurepath`.
+
+### Python API
+Add it to your project with [pipenv](https://pipenv.pypa.io):
+
+    pipenv install sha256bit
+
+If `pipenv` is missing: `pipx install pipenv`.
 
 ## Usage
 
@@ -90,22 +109,20 @@ you can also run each test separately:
 
 ## Generate the doc
 
-    cd docs
-    pipenv shell
-    make clean doctest html
+    pipenv sync --dev
+    pipenv run make -C docs clean doctest html
+
+## Update pipenv
 
-## Update pipenv for the doc
+The root `Pipfile` holds the tools for building, linting and the doc, all in `[dev-packages]` since the package itself has no dependencies. CI and Read the Docs install the versions pinned in `Pipfile.lock`, so commit it after updating:
 
-    cd docs
-    pipenv shell
-    #use pip to update whatever ou want
-    pip freeze > requirements.txt
-    pipenv update
+    pipenv update --dev
     
 ## Build the package
-Build is done using `hatchling`. The script `build` allows to build for different version of python3:
+Build is done using `hatchling`.
 
-    ./build python3.12
+    pipenv sync --dev
+    pipenv run ./build
 
 
 ## Create a new version
@@ -114,5 +131,6 @@ Version is managed by `hatch-vcs`, you just need to create a tag in github.
 ## Launch linters
 They use the configuration from `pyproject.toml`
 
-    ./lint
+    pipenv sync --dev
+    pipenv run ./lint
 

{sha256bit-0.2.3/docs → sha256bit-0.2.4}/Pipfile

@@ -4,11 +4,14 @@ verify_ssl = true
 name = "pypi"
 
 [packages]
+
+[dev-packages]
+build = "*"
+black = "*"
+ruff = "*"
 sphinx = "*"
 sphinx-rtd-theme = "*"
 sphinx-autodoc-typehints = "*"
 
-[dev-packages]
-
 [requires]
 python_version = "3.12"