woodrowbarlow / c64os-util Goto Github PK

the zipfile module does this.

https://docs.python.org/3/library/zipfile.html
https://github.com/python/cpython/blob/3.11/Lib/zipfile.py#L2310

additional reading:
https://discuss.python.org/t/fixing-subclassing-in-pathlib/8983
https://bugs.python.org/issue24132
python/cpython#31691

shutil contains an API for archives.

https://docs.python.org/3/library/shutil.html#archiving-operations

it is possible to register an archive format and an unpack format
we should do this so people can work with car files using the standard api.

see also:
https://github.com/python/cpython/blob/3.11/Lib/tarfile.py

Helper functions that hide the details of serializing/deserializing. Accepts a path as an argument.

https://amb.osdn.io/

(these aren't currently supported in c64os.)

[ ] decide high-level structure
[ ] add installation instructions
[ ] add scripts (preferably autodoc)
[ ] flesh out details
[ ] add code examples
[ ] proofread

It should be possible to invoke an instance of an archive. The interface should be similar to the standard open function.

This function will provide a way to create, read, edit, or append files inside the archive.

This function will accept a path argument and a mode argument.

This function will support both binary and text modes.

This function will support specifying the text encoding, and will default to petscii lowercase.

This function will support specifying the line endings, and will default to '\r'.

This function will support specifying the record type (SEQ or PRG) and will default to SEQ in text mode or PRG in binary mode.

Example usage:

archive = load_car('path/to/archive.car')

with archive('path/to/inner/file.t', 'r') as f:
    for line in f:
        print(line)

with archive('path/to/new/file.t', 'w') as f:
    f.write('hello world')

The check-version job should has outputs: LOCAL (the version declared in pyproject.toml) and REMOTE (the latest version published on PyPI).

The deploy job contains:

needs: check-version
if: ${{ needs.check-version.outputs.LOCAL != needs.check-version.outputs.REMOTE }}

It seems like needs.check-version.outputs.LOCAL and needs.check-version.outputs.REMOTE are both empty strings, and the deploy job always gets skipped.

Then restore the steps removed in: 1d0020c2086ac38ee885952d570fd62c47ebb4ea

walk should support max_depth
need tests for both