sepia

Version, currently 0.2.02 versions

github.com/ralsina/sepia

A serializer focused on storing a tree of objects to disk in an intuitive way

4 stars
2 dependents
License: MIT

Nothing has been indexed for 0.2.0 yet. The tag is recorded, its shard.yml has not been read, so the manifest and dependency list below are empty because they are unknown rather than because they are absent.

Installation

# Add this to your shard.yml
dependencies:
  sepia:
    github: ralsina/sepia
    version: ~> 0.2.0

Then run:

shards install

shard.yml

No shard.yml has been indexed for 0.2.0. You can read it on the repository.

Dependencies

Unknown: the shard.yml for this version has not been read yet.

README

This README is the one indexed from the repository at its latest ref, not from the tag for this version.

Sepia

⚠️ Warning: Unstable API and Storage Format Sepia is currently in active development and does not have a stable API or storage format. The API is subject to change without notice, and breaking changes may occur in any release. Additionally, the on-disk storage format is not stable - you will need to migrate your data stores when upgrading between versions. Use at your own risk in production.

Sepia is a file-system-based serialization library for Crystal that provides two main modules:

  • Sepia::Serializable: Objects serialize to single files
  • Sepia::Container: Objects serialize as directories containing nested objects

Installation

Add to your shard.yml:

dependencies:
  sepia:
    github: ralsina/sepia

Documentation

📖 Full Documentation: https://ralsina.github.io/sepia

The documentation site includes:

  • Getting started guide
  • API reference
  • Examples and tutorials
  • Advanced features (backup, file watching, event logging)

Development

Run tests with crystal spec.

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a Pull Request