wads.licensing

Licensing

Functions

get_licenses([refresh])

get_licenses_from_github()

get_licenses_json_from_github You need to have a github token placed in the right place for this! See pygithub for details.

license_body([license, ...])

license_info([license, ...])

licenses_dict([refresh])

resolve_author([author, pyproject_authors, url])

Resolve the author name following a priority chain.

substitute_license_placeholders(license_text)

Replace placeholders in license text with actual values.
wads.licensing.get_licenses_from_github()[source]

get_licenses_json_from_github You need to have a github token placed in the right place for this! See pygithub for details.

license_jsons = get_licenses_json_from_github()
wads.licensing.resolve_author(author=None, pyproject_authors=None, url=None)[source]

Resolve the author name following a priority chain.

Priority order:

  1. If author is explicitly provided, use it

  2. If pyproject_authors is provided, use the first author’s name

  3. If url is a GitHub URL, extract the org/user from it

  4. If WADS_DFLT_AUTHOR env variable is set, use it

  5. Return placeholder if nothing else works

Parameters:

  • author (Optional[str]) – Explicitly provided author name

  • pyproject_authors (Optional[list]) – List of author dicts from pyproject.toml

  • url (Optional[str]) – Project URL (e.g., GitHub URL)

Return type:

str

Returns:

Resolved author name or placeholder

>>> resolve_author(author='John Doe')
'John Doe'
>>> resolve_author(pyproject_authors=[{'name': 'Jane Smith'}])
'Jane Smith'
>>> resolve_author(url='https://github.com/myorg/myrepo')
'myorg'
wads.licensing.substitute_license_placeholders(license_text, author=None, year=None)[source]

Replace placeholders in license text with actual values.

Common placeholders:

  • [yyyy], [year] -> current year

  • [fullname], [name of copyright owner] -> author name

    1. -> © (optional enhancement)

Parameters:

  • license_text (str) – License text with placeholders

  • author (Optional[str]) – Author/copyright owner name (if None, placeholder remains)

  • year (Optional[int]) – Year for copyright (if None, uses current year)

Return type:

str

Returns:

License text with substituted values

>>> text = "Copyright [yyyy] [fullname]"
>>> result = substitute_license_placeholders(text, author='John', year=2025)
>>> result
'Copyright 2025 John'