Skip to content

bytesense v0.1.1

Release date: 2025-03-26

Maintenance and documentation-focused release after the first PyPI publish: runnable examples, a MkDocs site on GitHub Pages, packaging fixes for PyPI (logo + LICENSE in the sdist), and a Contributor Covenant code of conduct.

Highlights

  • Documentation site: https://oguzhankir.github.io/bytesense/ — built with MkDocs Material, deployed via GitHub Actions (Docs Pages workflow on main).
  • pip install -e ".[docs]" optional extra: mkdocs, mkdocs-material, pymdown-extensions; project.urls.Documentation points at the live docs URL.
  • examples/ directory with scripts for: basic from_bytes / from_path, chardet-style detect(), StreamDetector streaming, mojibake repair, HTTP/HTML hints, and multi-encoding detect_multi().
  • README / PyPI: logo uses an absolute raw.githubusercontent.com URL so the image renders on pypi.org (the sdist does not ship assets/ for local paths).
  • Packaging: LICENSE is included in the maturin sdist ([tool.maturin] include) so PyPI accepts License-File metadata.
  • Community: CODE_OF_CONDUCT.md (Contributor Covenant 2.1).

Notes for integrators

  • No breaking API changes versus v0.1.0; bump is safe for semver consumers on 0.1.x.
  • To preview docs locally: pip install -e ".[docs]" then mkdocs serve.

Full change list

See CHANGELOG.md for the detailed Added / Fixed sections for this version.