Structura

Structura is a Python library that provides data structures that are implemented in C for better performance. Its main purpose is to provide a simple and easy interface for data structures. The name comes from the Latin word structura which means structure.

Contents

Installation
Documentation
General Information
Using Structura
What's New
What's Coming
Contributing
Proposals for enhancement

Installation

Structura is available on PyPI and can be installed with pip. It requires Python 3.5 or above.

pip install structura

From Source

git clone github.com/sekomer/structura
cd structura
sudo python3 setup.py install

Documentation

Detailed documentation can be found in the docs folder.

General Information

Source code: https://github.com/sekomer/structura
Documentation: https://github.com/Sekomer/structura/tree/main/docs
Issue tracker: https://github.com/sekomer/structura/issues

Using Structura

Structura API follows the pythonic way of doing things. It has a simple and straightforward interface. Its works with any type of data and python objects. Heres a quick example of how to use it with RingBuffer data structure.

from structura import RingBuffer

buffer = RingBuffer(capacity=3)

buffer.enqueue(0) # [0]
buffer.enqueue(1) # [0, 1]
buffer.enqueue(2) # [0, 1, 2]
buffer.enqueue(3) # [1, 2, 3]

buffer.is_full() # True
buffer.peek()    # 1

a = buffer.dequeue() # [2, 3]
b = buffer.dequeue() # [3]
c = buffer.dequeue() # []
print(a, b, c)       # 1 2 3

for i in range(3):
    buffer.enqueue(i)

buffer.clear()    # []
buffer.is_empty() # True