{"id":16964960,"url":"https://github.com/propensive/zeppelin","last_synced_at":"2025-04-05T15:45:56.601Z","repository":{"id":153378983,"uuid":"629200177","full_name":"propensive/zeppelin","owner":"propensive","description":"Work with ZIP files in Scala","archived":false,"fork":false,"pushed_at":"2025-02-02T20:19:08.000Z","size":2577,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-28T20:49:20.693Z","etag":null,"topics":["pkzip","scala","zip","zip-files"],"latest_commit_sha":null,"homepage":"","language":"Scala","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/propensive.png","metadata":{"files":{"readme":".github/readme.md","changelog":null,"contributing":".github/contributing.md","funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-17T20:45:52.000Z","updated_at":"2025-02-02T20:19:12.000Z","dependencies_parsed_at":"2023-11-16T09:26:44.632Z","dependency_job_id":"0c65ece2-09e0-4717-935f-8a49e9c6e60e","html_url":"https://github.com/propensive/zeppelin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Fzeppelin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Fzeppelin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Fzeppelin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/propensive%2Fzeppelin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/propensive","download_url":"https://codeload.github.com/propensive/zeppelin/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247361598,"owners_count":20926642,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["pkzip","scala","zip","zip-files"],"created_at":"2024-10-13T23:44:41.713Z","updated_at":"2025-04-05T15:45:56.577Z","avatar_url":"https://github.com/propensive.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"[\u003cimg alt=\"GitHub Workflow\" src=\"https://img.shields.io/github/actions/workflow/status/propensive/zeppelin/main.yml?style=for-the-badge\" height=\"24\"\u003e](https://github.com/propensive/zeppelin/actions)\n[\u003cimg src=\"https://img.shields.io/discord/633198088311537684?color=8899f7\u0026label=DISCORD\u0026style=for-the-badge\" height=\"24\"\u003e](https://discord.com/invite/MBUrkTgMnA)\n\u003cimg src=\"/doc/images/github.png\" valign=\"middle\"\u003e\n\n# Zeppelin\n\n____\n\n_Zeppelin_ makes it easy to work with ZIP files in Scala, providing methods for efficiently reading\nand writing files within a ZIP archive, in a streaming or random access style.\n\n## Features\n\n- provides methods for reading and writing ZIP files\n- integrates seamlessly with Galilei and third-party file representations\n- both streaming and random-access APIs are provided\n- integrates directly with Turbulence readable and writable types\n\n\n## Availability\n\n\n\n\n\n\n\n## Getting Started\n\n### Creating a ZIP file\n\nA ZIP file can be constructed from an existing file by passing it to the `ZipFile` constructor.\nProvided there is an appropriate `GenericPathReader` and `GenericPathMaker` (from\n[Anticipation](https://github.com/propensive/anticipation)) in scope, any file representation (such\nas `java.io.File`) may be used. For example,\n```scala\nimport zeppelin.*\nimport diuretic.*\nval file: java.io.File = java.io.File(\"/home/work/data.zip\")\nval zip = ZipFile(file)\n```\nor,\n```scala\nimport zeppelin.*\nimport anticipation.fileApi.galileiApi\nval file: galilei.DiskPath = Unix / p\"home\" / p\"work\" / p\"data.zip\"\nval zip = ZipFile(file)\n```\n\n`ZipFile` provides several methods for working with the file.\n\n#### Reading entries from a ZIP file\n\nTo read every entry from a `ZipFile`, call `ZipFile#entries()`. This will return a `LazyList[ZipEntry]`, a stream\nof `ZipEntry`s in the order they are stored within the file, each one consisting of a `Relative` path (relative to\nthe root of the ZIP file) and a method to get its contents.\n\n`ZipEntry`s support [Turbulence](https://github.com/propensive/turbulence/)'s `Readable` interface, so they can be\nread as any type for which an `Aggregable` instance exists.\n\n#### Appending files to an existing ZIP file\n\nTo add additional entries to a `ZipFile`, use `ZipFile#append`, which takes a\n`LazyList` of `ZipEntry`s to append.\n\nThis method includes two additional parameters: a `prefix`, a `Bytes`\n(`IArray[Byte]`) value to be inserted in raw form at the start of the ZIP file,\ntypically used to make the ZIP file executable; and a `timestamp` value for\nspecifying the timestamp of each entry appended to the ZIP file. If no\n`timestamp` is specified, the current time will be used.\n\n\n\n\n\n## Status\n\nZeppelin is classified as __fledgling__. For reference, Soundness projects are\ncategorized into one of the following five stability levels:\n\n- _embryonic_: for experimental or demonstrative purposes only, without any guarantees of longevity\n- _fledgling_: of proven utility, seeking contributions, but liable to significant redesigns\n- _maturescent_: major design decisions broady settled, seeking probatory adoption and refinement\n- _dependable_: production-ready, subject to controlled ongoing maintenance and enhancement; tagged as version `1.0.0` or later\n- _adamantine_: proven, reliable and production-ready, with no further breaking changes ever anticipated\n\nProjects at any stability level, even _embryonic_ projects, can still be used,\nas long as caution is taken to avoid a mismatch between the project's stability\nlevel and the required stability and maintainability of your own project.\n\nZeppelin is designed to be _small_. Its entire source code currently consists\nof 208 lines of code.\n\n## Building\n\nZeppelin will ultimately be built by Fury, when it is published. In the\nmeantime, two possibilities are offered, however they are acknowledged to be\nfragile, inadequately tested, and unsuitable for anything more than\nexperimentation. They are provided only for the necessity of providing _some_\nanswer to the question, \"how can I try Zeppelin?\".\n\n1. *Copy the sources into your own project*\n   \n   Read the `fury` file in the repository root to understand Zeppelin's build\n   structure, dependencies and source location; the file format should be short\n   and quite intuitive. Copy the sources into a source directory in your own\n   project, then repeat (recursively) for each of the dependencies.\n\n   The sources are compiled against the latest nightly release of Scala 3.\n   There should be no problem to compile the project together with all of its\n   dependencies in a single compilation.\n\n2. *Build with [Wrath](https://github.com/propensive/wrath/)*\n\n   Wrath is a bootstrapping script for building Zeppelin and other projects in\n   the absence of a fully-featured build tool. It is designed to read the `fury`\n   file in the project directory, and produce a collection of JAR files which can\n   be added to a classpath, by compiling the project and all of its dependencies,\n   including the Scala compiler itself.\n   \n   Download the latest version of\n   [`wrath`](https://github.com/propensive/wrath/releases/latest), make it\n   executable, and add it to your path, for example by copying it to\n   `/usr/local/bin/`.\n\n   Clone this repository inside an empty directory, so that the build can\n   safely make clones of repositories it depends on as _peers_ of `zeppelin`.\n   Run `wrath -F` in the repository root. This will download and compile the\n   latest version of Scala, as well as all of Zeppelin's dependencies.\n\n   If the build was successful, the compiled JAR files can be found in the\n   `.wrath/dist` directory.\n\n## Contributing\n\nContributors to Zeppelin are welcome and encouraged. New contributors may like\nto look for issues marked\n[beginner](https://github.com/propensive/zeppelin/labels/beginner).\n\nWe suggest that all contributors read the [Contributing\nGuide](/contributing.md) to make the process of contributing to Zeppelin\neasier.\n\nPlease __do not__ contact project maintainers privately with questions unless\nthere is a good reason to keep them private. While it can be tempting to\nrepsond to such questions, private answers cannot be shared with a wider\naudience, and it can result in duplication of effort.\n\n## Author\n\nZeppelin was designed and developed by Jon Pretty, and commercial support and\ntraining on all aspects of Scala 3 is available from [Propensive\nO\u0026Uuml;](https://propensive.com/).\n\n\n\n## Name\n\nLike a ZIP file, a zeppelin airship may be inflated or deflated, and the name furthermore is an allusion to _zip_ping.\n\nIn general, Soundness project names are always chosen with some rationale,\nhowever it is usually frivolous. Each name is chosen for more for its\n_uniqueness_ and _intrigue_ than its concision or catchiness, and there is no\nbias towards names with positive or \"nice\" meanings—since many of the libraries\nperform some quite unpleasant tasks.\n\nNames should be English words, though many are obscure or archaic, and it\nshould be noted how willingly English adopts foreign words. Names are generally\nof Greek or Latin origin, and have often arrived in English via a romance\nlanguage.\n\n## Logo\n\nThe logo shows the overlaid shapes of three zippers.\n\n## License\n\nZeppelin is copyright \u0026copy; 2025 Jon Pretty \u0026 Propensive O\u0026Uuml;, and\nis made available under the [Apache 2.0 License](/license.md).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpropensive%2Fzeppelin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpropensive%2Fzeppelin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpropensive%2Fzeppelin/lists"}