Skip to content

docs, build: document GitHub installation and license under LGPL-3.0-or-later - #34

Merged
notdodo merged 2 commits into
mainfrom
docs/github-install-and-lgpl-license
Nov 15, 2026
Merged

notdodo merged 2 commits into
mainfrom
docs/github-install-and-lgpl-license

Conversation

@notdodo

@notdodo notdodo commented Nov 15, 2026

Copy link
Copy Markdown
Member

Summary

Installation. The README told users to run uv add digintlab-langfuse-python, but the package isn't on PyPI (404).

  • The README now documents installing from a pinned release tag: uv add "digintlab-langfuse-python @ git+https://github.com/DigintLab/digintlab-langfuse-python@v0.3.0".
  • It also shows the pip equivalent, the [redaction] extra, and downloading the release wheel with gh release download.
  • Git installs use the user's Git credentials while the repository is private.
  • The missing-extra error in redaction.py no longer quotes a PyPI-only command; it points to the README.

Licensing. The package metadata said Proprietary and there was no license file.

  • The package is now licensed LGPL-3.0-or-later.
  • COPYING (GPL-3.0) and COPYING.LESSER (LGPL-3.0) are added unchanged from gnu.org, and their SHA-256 hashes match the official texts.
  • pyproject.toml uses the PEP 639 license / license-files fields plus the LGPLv3+ classifier.
  • The README has a License section saying what is permitted: use, including in proprietary applications that import the library unmodified. Anyone who distributes a modified version of the library must release those modifications under the LGPL.
  • CHANGELOG.md has an Unreleased entry.

Validation

  • task format check test: 135 passed, ruff and mypy strict clean.
  • uv build: the wheel contains both license files under dist-info/licenses/, and METADATA has License-Expression: LGPL-3.0-or-later.
  • uv pip compile resolves the documented git requirement.

🤖 Generated with Claude Code

notdodo and others added 2 commits November 15, 2026 10:33
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions

Copy link
Copy Markdown

kics-logo

KICS version: v2.1.20

Category Results
CRITICAL CRITICAL 0
HIGH HIGH 0
MEDIUM MEDIUM 0
LOW LOW 0
INFO INFO 0
TRACE TRACE 0
TOTAL TOTAL 0
Metric Values
Files scanned placeholder 0
Files parsed placeholder 0
Files failed to scan placeholder 0
Total executed queries placeholder 0
Queries failed to execute placeholder 0
Execution time placeholder 0

Queries Results

|
|

@notdodo
notdodo merged commit 3d5cd8d into main Nov 15, 2026
@notdodo
notdodo deleted the docs/github-install-and-lgpl-license branch November 15, 2026 09:34
notdodo added a commit that referenced this pull request Nov 15, 2026
## Summary
- `requires-python` widened from `>=3.13,<3.15` to `>=3.13,<3.16`; added
the `Python :: 3.15` classifier.
- CI matrix now runs 3.13, 3.14, and 3.15.
- `uv.lock` relocked; the extra lines are the cp315 wheel entries. No
dependency version changes.
- README and CHANGELOG (Unreleased) updated.

## Validation
- Locally on CPython 3.15.2 with the `redaction` extra (spaCy and
presidio included): `mypy` strict is clean, and `pytest -m "not e2e"
--max-warnings=0` passes all 135 tests with no deprecation warnings.
- `task format check test` and `uv build` pass on the default
interpreter.

## Notes
- This conflicts textually with #33 (CI inlining) on the matrix line and
with #34 on the CHANGELOG `Unreleased` section. Whichever merges second
needs a one-line rebase.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant