Python implementation of [Earthstar](https://earthstar-project.org/)
Go to file
2022-05-06 09:41:12 +02:00
earthsnake Create the es.4 document format 2022-05-06 09:41:12 +02:00
mypy-stubs Add fastjsonschema as a dependency 2022-05-06 09:40:55 +02:00
tests Create the es.4 document format 2022-05-06 09:41:12 +02:00
.gitignore Initial version with identity handling 2022-05-03 08:33:18 +02:00
LICENSE Initial version with identity handling 2022-05-03 08:33:18 +02:00
poetry.lock Add fastjsonschema as a dependency 2022-05-06 09:40:55 +02:00
pyproject.toml Add fastjsonschema as a dependency 2022-05-06 09:40:55 +02:00
README.rst [Code Cleanup] Format source files with black 2022-05-03 16:36:25 +02:00

Python implementation of Earthstar
##################################

**WARNING!**

This library is very limited in functionality, and is under active development.  Be prepared for
things to break.

Usage
=====

Create an identity and save it as a mnemonic:

.. code-block:: python

   from earthsnake import Identity

   identity = Identity('test')
   mnemonic = identity.mnemonic

Then you can load it back from the mnemonic:

.. code-block:: python

   identity = Identity.from_mnemonic(mnemonic)

Development
===========

Type checking:

.. code-block:: sh

   env MYPYPATH=mypy-stubs poetry run mypy --strict earthsnake tests

Static linting:

.. code-block:: sh

   poetry run pylint earthsnake tests

Code style check:

.. code-block:: sh

   poetry run black --diff --skip-string-normalization earthsnake tests

Tests:

.. code-block:: sh

   poetry run pytest -vv --cov=. tests