python crossword puzzle library

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for Alex.DeJarnatt from gravatar.com Alex.DeJarnatt Avatar for svisser from gravatar.com svisser

Unverified details

These details have not been verified by PyPI
Meta
Classifiers
Report project as malware

Project description

puz.py: Python parser for .puz files

Python library to read and write crossword puzzle files in Across Lite .puz and/or .txt formats.

Example Usage

import puz

# Load a puzzle file:
p = puz.read('testfiles/washpost.puz')

# Print clues with answers:
numbering = p.clue_numbering()
solution = puz.Grid(p.solution, p.width, p.height)

print('Across')
for clue in numbering.across:
    answer = solution.get_string_for_clue(clue)
    print(clue['num'], clue['clue'], '-', answer)

print('Down')
for clue in numbering.down:
    answer = solution.get_string_for_clue(clue)
    print(clue['num'], clue['clue'], '-', answer)

# Print the grid:
grid = puz.Grid(p.fill, p.width, p.height)
for row in range(p.height):
    print(' '.join(grid.get_row(row)))

# Unlock a scrambled solution:
p.unlock_solution(7844)

# Print the unscrambed solution grid:
solution = puz.Grid(p.solution, p.width, p.height)
for row in range(p.height):
    print(' '.join(solution.get_row(row)))

# Save a puzzle with modifications:
p.fill = 'LAMB' + p.fill[4:]
p.save('example.puz')

# New! Convert from Across Lite text format to .puz:
p2 = puz.read_text('testfiles/text_format_v1.txt')
p2.save('example2.puz')

Notes

The parser is as strict as Across Lite, enforcing internal checksums and magic strings. The parser is designed to round-trip all data in the file, even fields whose utility is unknown. This makes testing easier. It is resilient to garbage at the beginning and end of the file (for example some publishers put the filename on the first line and some files have a rn at the end).

In addition to the handful of tests checked in here, the library has been tested on over 9700 crossword puzzles in .puz format drawn from the archives of several publications including The New York Times, The Washington Post, The Onion, and, the Wall Street Journal. As of writing, it can round-trip 100% of them with full fidelity.

Running tests

To run the full suite of tests: tox

To run tests using the currently installed version: pytest

To run a subset of tests on python 2.7: python2 -m unittest tests

Python version support

All currently supported python3 versions are supported. Python 2.7 was supported, and may still work, though ongoing support is not guaranteed.

Resources

License

MIT License.

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for Alex.DeJarnatt from gravatar.com Alex.DeJarnatt Avatar for svisser from gravatar.com svisser

Unverified details

These details have not been verified by PyPI
Meta
Classifiers

Release history Release notifications | RSS feed

This version

0.3.2

0.3.1

0.3.0 yanked

Reason this release was yanked:

problem with package

0.2.6

0.2.5

0.2.4

0.2.3

0.2.2

0.2.1

0.2

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

puzpy-0.3.2.tar.gz (13.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

puzpy-0.3.2-py3-none-any.whl (11.7 kB view details)

Uploaded Python 3

File details

Details for the file puzpy-0.3.2.tar.gz.

File metadata

  • Download URL: puzpy-0.3.2.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for puzpy-0.3.2.tar.gz
Algorithm Hash digest
SHA256 35eac8d8ef3f745d6aa457df8a6f12bde832c4a6bc02827a01ff466f9d552c62
MD5 e72a241bf97953ae8c08ea52574f8e0a
BLAKE2b-256 0630b57c5519e2ff3ec26606922158cf1dc2aafe992292a4bae0fb1756dffa27

See more details on using hashes here.

Provenance

The following attestation bundles were made for puzpy-0.3.2.tar.gz:

Publisher: publish.yml on alexdej/puzpy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file puzpy-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: puzpy-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 11.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for puzpy-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 429187aad6baf234b73aa368e843071b06a3ed479b12fabfbeeefbce143a2e98
MD5 dd36af8e905ad96ba51248054e3bc3f6
BLAKE2b-256 68fec45acdf97ad2fcc3f42274bad7dcedf342f7102bfb55a1705599837a0c62

See more details on using hashes here.

Provenance

The following attestation bundles were made for puzpy-0.3.2-py3-none-any.whl:

Publisher: publish.yml on alexdej/puzpy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page