Skip to content
Snippets Groups Projects
Select Git revision
  • 02add38ecec896e0a1dfa126eec1e22422d7a7b9
  • main default protected
  • release/1.1
  • encrypt_comments
  • mnemonic_dewif
  • authors_rules
  • 0.14
  • rtd
  • 1.2.1 protected
  • 1.2.0 protected
  • 1.1.1 protected
  • 1.1.0 protected
  • 1.0.0 protected
  • 1.0.0rc1 protected
  • 1.0.0rc0 protected
  • 1.0.0-rc protected
  • 0.62.0 protected
  • 0.61.0 protected
  • 0.60.1 protected
  • 0.58.1 protected
  • 0.60.0 protected
  • 0.58.0 protected
  • 0.57.0 protected
  • 0.56.0 protected
  • 0.55.1 protected
  • 0.55.0 protected
  • 0.54.3 protected
  • 0.54.2 protected
28 results

test_ws2p.py

Blame
  • index.md 8.42 KiB

    Contributing

    Goals

    Part of the Duniter project running the Ğ1 currency, Silkaj project is aiming at creating a generic tool to manage the main account and wallets, to administrate and to monitor the currency.

    Install the development environment

    We are using Poetry as a development environment solution. Start by installing Poetry. This will install a sandboxed Python environment. Dependencies will be installed in it in order to have Silkaj running and to have pre-installed developement tools.

    Workflow

    • We use branches for merge requests
    • We prefer fast-forward and rebase method than having merge commits created. This in order to have a clean history.

    Branches

    • main: development and stable branch
    • maintainance branches, to maintain a stable version while developing future version with breaking changes. For instance: release/0.12

    Developing with DuniterPy

    DuniterPy logo

    DuniterPy is a Python library for Duniter v1 clients. It implements a client with multiple APIs, the handling for document signing. As it is coupled with Silkaj, it is oftenly needed to develop in both repositories.

    How to use DuniterPy as editable with Poetry

    Clone DuniterPy locally alongside of silkaj repository:

    silkaj> cd ..
    git clone https://git.duniter.org/clients/python/duniterpy

    Use DuniterPy as a path dependency:

    poetry add ../duniterpy

    Developing with modules

    Silkaj is using Python modules which shape kind of a framework. Please read their documentations on how to use them the best possible.