Skip to main content

Storage abstraction layer for managing logical spaces.

Project description

A lightweight, fully-tested Python library to manage logical file-based spaces. Ideal for sandboxing, test environments, or dynamic storage orchestration.

Build Status Deploy Status Codecov Black code style License PyPi GitHub Pages

🚀 Overview

darca-space-manager provides a simple abstraction over local file storage by organizing content in logical “spaces”. Each space has its own metadata and supports file-level operations such as reading, writing, deleting, and listing — including support for structured content like YAML and JSON.

✨ Features

  • Space creation, deletion, existence checks, and metadata tracking

  • File read/write/delete operations within a given space

  • Automatic handling of .yaml, .yml, and .json for dictionaries

  • Strict ASCII validation when reading text

  • Custom exceptions for robust error tracing (SpaceFileManagerException, SpaceManagerException)

  • Parallel-safe test fixtures (100% test coverage)

  • CI/CD pipelines, auto-doc generation, and live documentation via GitHub Pages

📦 Installation

pip install darca-space-manager

Or using Poetry:

poetry add darca-space-manager

🔧 Usage

from darca_space_manager import SpaceManager, SpaceFileManager

sm = SpaceManager()
sfm = SpaceFileManager()

sm.create_space("demo")
sfm.set_file("demo", "example.yaml", {"foo": "bar"})
print(sfm.get_file("demo", "example.yaml"))  # raw text
sm.delete_space("demo")

📚 Documentation

Visit the full documentation:

👉 https://roelkist.github.io/darca-space-manager/

To build locally:

make docs

📂 Project Layout

darca_space_manager/
├── config.py
├── space_executor.py
├── space_file_manager.py
├── space_manager.py
└── __version__.py

🧪 Testing

Run all tests using:

make test

Coverage and reports:

  • Generates coverage.svg badge

  • Stores HTML output in htmlcov/

  • Fully parallel test support with xdist

🤝 Contributing

We welcome all contributions!

  • Create a new branch from main

  • Use PRs to submit changes

  • You can also open feature requests or issues using our GitHub templates

See CONTRIBUTING.rst for detailed guidelines.

📄 License

This project is licensed under the MIT License. See LICENSE for details.

Project details


Download files

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

Source Distribution

darca_space_manager-0.5.1.tar.gz (11.1 kB view details)

Uploaded Source

Built Distribution

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

darca_space_manager-0.5.1-py3-none-any.whl (12.5 kB view details)

Uploaded Python 3

File details

Details for the file darca_space_manager-0.5.1.tar.gz.

File metadata

  • Download URL: darca_space_manager-0.5.1.tar.gz
  • Upload date:
  • Size: 11.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for darca_space_manager-0.5.1.tar.gz
Algorithm Hash digest
SHA256 fe195b18a073cb092775999ef4df55549e34dceaa2bfc54efc74d6b717e527ec
MD5 4cb3485056ce31243937fb25a6686828
BLAKE2b-256 1dd42289952418c2429b62eab3301ce717157f4a66dbcf9315b285dae34e737a

See more details on using hashes here.

Provenance

The following attestation bundles were made for darca_space_manager-0.5.1.tar.gz:

Publisher: cd.yml on roelkist/darca-space-manager

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

File details

Details for the file darca_space_manager-0.5.1-py3-none-any.whl.

File metadata

File hashes

Hashes for darca_space_manager-0.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e881959dce0f86d044c3ab1a5f317c0e4c24925c48a148e856a100373184459d
MD5 571c3dc5dfca711430fe3741cfef7e63
BLAKE2b-256 54fb85db9e4962bab3efd4350e6c22398194d7d19abf91fd00d5c1a193ee241d

See more details on using hashes here.

Provenance

The following attestation bundles were made for darca_space_manager-0.5.1-py3-none-any.whl:

Publisher: cd.yml on roelkist/darca-space-manager

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