Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Ankvik-Tech-Labs/mantaray-py
Mantaray data structure in python
https://github.com/Ankvik-Tech-Labs/mantaray-py
data-structures hatch hatchling mantaray python python12 python3 python310 python311 python39 virtualenv
Last synced: 3 months ago
JSON representation
Mantaray data structure in python
- Host: GitHub
- URL: https://github.com/Ankvik-Tech-Labs/mantaray-py
- Owner: Ankvik-Tech-Labs
- License: bsd-3-clause
- Created: 2024-05-30T08:03:49.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-06-23T15:34:34.000Z (8 months ago)
- Last Synced: 2024-09-29T06:47:51.684Z (5 months ago)
- Topics: data-structures, hatch, hatchling, mantaray, python, python12, python3, python310, python311, python39, virtualenv
- Language: Python
- Homepage: https://ankvik-tech-labs.github.io/mantaray-py/
- Size: 134 KB
- Stars: 1
- Watchers: 0
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/funding.yml
- License: LICENSE
- Authors: AUTHORS.md
Awesome Lists containing this project
- awesome-swarm - Mantaray-py - Allows you to manipulate and interpret mantaray data via MantarayNode and MantarayFork abstractions. (Projects / Libraries)
README
# mantaray py
Mantaray data structure in Python
| Feature | Value |
| ------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Technology | [](https://www.python.org/) [](https://github.com/pypa/hatch) [](https://github.com/features/actions) [](https://github.com/Ankvik-Tech-Labs/mantaray-py/actions/workflows/tests.yml/badge.svg) |
| Type Checking | [](https://github.com/astral-sh/ruff) [](http://mypy-lang.org/) |
| CI/CD | [](https://github.com/Ankvik-Tech-Labs/mantaray-py/actions/workflows/build.yml) [](https://github.com/Ankvik-Tech-Labs/mantaray-py/actions/workflows/tests.yml) [](https://github.com/Ankvik-Tech-Labs/mantaray-py/actions/workflows/labeler.yml) [](https://github.com/pre-commit/pre-commit) [](https://codecov.io/gh/Ankvik-Tech-Labs/mantaray-py) |
| Docs | [](https://github.com/Ankvik-Tech-Labs/mantaray-py/actions/workflows/build.yml) |
| Package | [](https://pypi.org/project/mantaray-py/) [](https://pypi.org/project/mantaray-py/) [](https://pypi.org/project/mantaray-py/) |
| Meta | [](https://github.com/Ankvik-Tech-Labs/mantaray-py/blob/main/LICENSE) [](https://github.com/Ankvik-Tech-Labs/mantaray-py/commits/main) [](https://github.com/Ankvik-Tech-Labs/mantaray-py/graphs/commit-activity) [](https://github.com/Ankvik-Tech-Labs/mantaray-py) |
# Description
With this package you can manipulate and interpret mantaray data via `MantarayNode` and `MantarayFork` abstractions.
# Installation
- Install using `pip`
```py
pip install mantaray_py
```
# Usage
### Construct Mantaray
```py
from mantaray_py import MantarayNode, MantarayFork, init_manifest_node, gen_32_bytes
node = init_manifest_node()
address1 = gen_32_bytes()
address2 = gen_32_bytes()
address3 = gen_32_bytes()
address4 = gen_32_bytes()
address5 = gen_32_bytes()
address6 = gen_32_bytes()
path1 = "path1/valami/elso".encode()
path2 = "path1/valami/masodik".encode()
path3 = "path1/valami/masodik.ext".encode()
path4 = "path1/valami".encode()
path5 = "path2".encode()
path6 = "path3/haha".encode()
node.add_fork(path1, address1, { "vmi": "elso" })
node.add_fork(path2, address2)
node.add_fork(path3, address3)
node.add_fork(path4, address4, {"vmi": "negy"})
node.add_fork(path5, address5)
node.add_fork(path6, address6, {"vmi": "haha"})
node.remove_path(path3)
print(node)
```
### Mantaray Storage Operations
```py
from mantaray_py import MantarayNode
node = MantarayNode()
"""
here `reference` parameter is a `Reference` type which can be a 32 or 64 of bytes
and `load_function` is a [load_function: (address: bytes): bytes] typed function
that returns the serialised raw data of a MantarayNode of the given reference. See tests/integration/test_int.py file for reference.
"""
node.load(load_function, reference)
# Manipulate `node` object then save it again
# (...)
# save into the storage with a storage handler [save_function: (data: bytes): Reference]
# See tests/integration/test_int.py file for reference.
reference = node.save(save_function)
```
How It Works
# node binary format
The following describes the format of a node binary format.
```
┌────────────────────────────────┐
│ obfuscationKey <32 byte> │
├────────────────────────────────┤
│ hash("mantaray:0.1") <31 byte> │
├────────────────────────────────┤
│ refBytesSize <1 byte> │
├────────────────────────────────┤
│ entry <32/64 byte> │
├────────────────────────────────┤
│ forksIndexBytes <32 byte> │
├────────────────────────────────┤
│ ┌────────────────────────────┐ │
│ │ Fork 1 │ │
│ ├────────────────────────────┤ │
│ │ ... │ │
│ ├────────────────────────────┤ │
│ │ Fork N │ │
│ └────────────────────────────┘ │
└────────────────────────────────┘
```
## Fork
```
┌───────────────────┬───────────────────────┬──────────────────┐
│ nodeType <1 byte> │ prefixLength <1 byte> │ prefix <30 byte> │
├───────────────────┴───────────────────────┴──────────────────┤
│ reference <32/64 bytes> │
│ │
└──────────────────────────────────────────────────────────────┘
```
### Fork with metadata
```
┌───────────────────┬───────────────────────┬──────────────────┐
│ nodeType <1 byte> │ prefixLength <1 byte> │ prefix <30 byte> │
├───────────────────┴───────────────────────┴──────────────────┤
│ reference <32/64 bytes> │
│ │
├─────────────────────────────┬────────────────────────────────┤
│ metadataBytesSize <2 bytes> │ metadataBytes │
├─────────────────────────────┘ │
│ │
└──────────────────────────────────────────────────────────────┘
```
---
**Documentation**: https://Ankvik-Tech-Labs.github.io/mantaray-py/
**Source Code**: https://github.com/Ankvik-Tech-Labs/mantaray-py
---
Development
## Development
### Setup environment
We use [Hatch](https://hatch.pypa.io/latest/install/) to manage the development environment and production build. Ensure it's installed on your system.
### Run unit tests
You can run all the tests with:
```bash
hatch run test:test
```
### Format the code
Execute the following command to apply linting and check typing:
```bash
hatch run lint:lint-check
```
### Publish a new version
You can bump the version, create a commit and associated tag with one command:
```bash
hatch version patch
```
```bash
hatch version minor
```
```bash
hatch version major
```
Your default Git text editor will open so you can add information about the release.
When you push the tag on GitHub, the workflow will automatically publish it on PyPi and a GitHub release will be created as draft.
## Serve the documentation
You can serve the Mkdocs documentation with:
```bash
hatch run docs:docs-serve
```
It'll automatically watch for changes in your code.
## License
This project is licensed under the terms of the [BSD 3-Clause License](https://github.com/Ankvik-Tech-Labs/mantaray-py/blob/main/LICENSE) license.