Metadata-Version: 2.1
Name: indiek-core
Version: 0.1.5
Summary: core logic for indiek
Home-page: https://pypi.org/project/indiek-core/
Author: Adrian Ernesto Radillo
Author-email: adrian.radillo@gmail.com
License: GNU Affero General Public License v3.0
Project-URL: GitHub, https://github.com/indiek/indiek.core
Project-URL: Documentation, https://indiekcore.readthedocs.io/en/latest/
Requires-Python: >=3.8
Provides-Extra: dev
License-File: LICENSE

Library that stores the core logic for the IndieK software suite.

This library is not meant to be used directly. Rather, it should be
used by GUIs or web apps that wish to comply with the IndieK API.

============
Installation
============

To install from PyPI: ``pip install indiek-core``

To develop, use the [dev] dependency specification, e.g.:
``pip install indiek-core[dev]``

Or from the cloned repo's top-level in editable mode:
``pip install -e .[dev]``

==========
Quickstart
==========

..  code-block:: python
    
    from indiek.core.items import Definition
    
    item1 = Definition(name='def1', content='example def 1')
    item1_id = item1.save()

    reloaded = Definition.load(item1_id)
    assert item1 == reloaded

    item1.delete()

=====
Tests
=====
To run the full test suite, type the following from the top level of this repo:
``pytest``
