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_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.3.0.tar.gz (6.2 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.3.0-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: darca_space_manager-0.3.0.tar.gz
  • Upload date:
  • Size: 6.2 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.3.0.tar.gz
Algorithm Hash digest
SHA256 3d4bc2742a7aeb87ee7f0cd3b233bdd67351346b844cf22ab4f143af9d7b5ea0
MD5 c927b2acd60571f7d764b0f2a8654186
BLAKE2b-256 892b8ef3dae428822ab8b96f8f1cc88a8353ac93a0546eece97e31d8a524242e

See more details on using hashes here.

Provenance

The following attestation bundles were made for darca_space_manager-0.3.0.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.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for darca_space_manager-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e4be81d6444f194e3abba2bd396556da7bd83e68330562cb85d6022e8cc17a46
MD5 fc766207dca34752cf6af0ad0d102d4d
BLAKE2b-256 1e7692287e2853e431f18fde6f23b65579fa07d2f40825a733ea6af98dd43c7e

See more details on using hashes here.

Provenance

The following attestation bundles were made for darca_space_manager-0.3.0-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