https://github.com/desultory/pycpio

Python library for CPIO manipulation
https://github.com/desultory/pycpio

cpio cpio-archives data initramfs pypi-package python python-3 python3

Last synced: about 1 month ago
JSON representation

Python library for CPIO manipulation

• Host: GitHub
• URL: https://github.com/desultory/pycpio
• Owner: desultory
• License: gpl-2.0
• Created: 2023-11-26T02:38:24.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-03-25T01:30:24.000Z (about 1 year ago)
• Last Synced: 2024-03-26T00:32:33.153Z (about 1 year ago)
• Topics: cpio, cpio-archives, data, initramfs, pypi-package, python, python-3, python3
• Language: Python
• Homepage:
• Size: 97.7 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
 ![Tests](https://github.com/desultory/pycpio/actions/workflows/unit_tests.yml/badge.svg)

![ZenlibTests](https://github.com/desultory/zenlib/actions/workflows/unit_tests.yml/badge.svg)

![Black](https://img.shields.io/badge/code%20style-black-000000.svg)

# PyCPIO

A library for creating CPIO files in Python.

Currently, the library only supports the New ASCII format.

xz and zstd compression types are currently suppored.

This library is primary designed for use in [ugrd](https://github.com/desultory/ugrd) to create CPIO archives for use in initramfs.

## Usage

```

  -h, --help            show this help message and exit

  -d, --debug           enable debug mode (level 10)

  -dd, --trace          enable trace debug mode (level 5)

  -v, --version         print the version and exit

  --log-file LOG_FILE   set the path to the log file

  --log-level LOG_LEVEL

                        set the log level

  --log-time            enable log timestamps

  --no-log-color        disable log color

  -i INPUT, --input INPUT

                        input file

  -a APPEND, --append APPEND

                        append to archive

  --recursive RECURSIVE

                        append to archive recursively

  --relative RELATIVE   append to archive relative to this path

  --absolute            allow absolute paths

  --reproducible        Set mtime to 0, start inodes at 0

  --rm RM, --delete RM  delete from archive

  -n NAME, --name NAME  Name/path override for append

  -s SYMLINK, --symlink SYMLINK

                        create symlink

  -c CHARDEV, --chardev CHARDEV

                        create character device

  --major MAJOR         major number for character/block device

  --minor MINOR         minor number for character/block device

  -u UID, --set-owner UID

                        set UID on all files

  -g GID, --set-group GID

                        set GID on all files

  -m MODE, --set-mode MODE

                        set mode on all files

  -z COMPRESS, --compress COMPRESS

                        compression type

  -o OUTPUT, --output OUTPUT

                        output file

  -l, --list            list CPIO contents

  -p, --print           print CPIO contents

  ```

# Structure

- `pycpio.header.cpioheader`: The class which represents a CPIO header

  * Can be initialized from args for header fields, or bytes representing a header

  * header types are defined in `pycpio.header.headers` (only the new ascii format is supported)

- `pycpio.cpio.data`: The class which represents a CPIO data block

  * Each CPIO object must have a header.

  * Currently the follwing subtypes are supported:

    - `file` : A regular file, or hardlink.

    - `dir` : A directory

    - `symlink` : A symbolic link

    - `chardev` : A character device

  * CPIO objects are collected in a `pycpio.cpio.archive` object

    - The archive handles duplication, inode generation, name normalization, and other collection related tasks

  * All CPIO object types can be initialized from args, bytes, or a file path