View Issue Details

IDProjectCategoryView StatusLast Update
0006649Talerdocumentationpublic2022-11-04 20:52
ReporterMS Assigned Tottn  
PrioritynormalSeveritytextReproducibilityhave not tried
Status closedResolutionfixed 
Target Version0.9 
Summary0006649: taler-util needs documentation
DescriptionThe various APIs exported by taler-util (Python module) need to be documented. It should also be agreed on *where* to write this documentation.
TagsNo tags attached.

Activities

Christian Grothoff

2021-01-01 16:40

manager   ~0017291

ttn: this may also be a task suitable for you, if you can read Python ;-)

ttn

2021-01-07 04:10

developer   ~0017317

I'm open to learning about taler-util and documenting it along the way.
I agree that *where* to put such docs is a good question. Hmmm...

Christian Grothoff

2021-01-07 09:42

manager   ~0017319

We're currently lacking a "real" chapter on the Python bank.
https://docs.taler.net/taler-bank-manual.html is hardly a skeleton for that.
It does not explain taler-bank-manage and its subcommands, or how to install, or what it does.

If we have a good chapter on the Python bank (bank.git), then I think in a section for _developers_ of the bank can contain a subsection on taler-util (as it is primarily used by the bank.git).

ttn

2022-02-10 07:58

developer   ~0018690

Is the Python bank still an ongoing concern? I have the impression that libeufin has a "demobank" facility nowadays and that the Python bank will be going away at some point. Am i missing something?

Christian Grothoff

2022-02-10 09:11

manager   ~0018691

The python bank itself shall die soon. So what we indeed need to then document is the libeufin bank. That said, taler-util (python library) may still survive, as it may be a reasonable starting point for people implementing taler-clients in python. But it'll be much less important.

ttn

2022-02-10 10:43

developer   ~0018693

@MS If you don't mind, i've assigned this to myself.
I'll write some preliminary docs while we figure out where to put the stuff.

ttn

2022-02-10 12:16

developer   ~0018694

I've run into a problem trying to get taler-util configured.
The "./bootstrap" script executes succesfully, but "./configure" signals error with exit value 2.
(See log, attached.)

What am i missing?
.ttn.configure.log (317 bytes)   
-*- mode: compilation; default-directory: "~/build/GNU/T/taler-util/" -*-
Compilation started at Thu Feb 10 06:13:23

./configure
/usr/bin/python3: can't open file '/home/ttn/build/GNU/T/taler-util/./configure.py': [Errno 2] No such file or directory

Compilation exited abnormally with code 2 at Thu Feb 10 06:13:23
.ttn.configure.log (317 bytes)   

ttn

2022-02-10 13:20

developer   ~0018695

After some poking around, i figured out the problem was two instances of "wrong directory".
I've pushed the following:

- https://git.taler.net/taler-util.git/commit/?id=7dcaeb5f161e455e2a3d04aaa2150fd87e1ba38c

Now i can do "./configure --prefix /tmp/a/b/c" as expected.

ttn

2022-02-10 16:29

developer   ~0018696

Good start w/ the Amount and SignedAmount classes:

- https://git.taler.net/taler-util.git/commit/?id=ef8e148d3672f776503b19eb47e9b161d1c61091

@MS PTAL, especially the "import FOO as BAR" -- is that idiomatic? Or is there a better way?

ttn

2022-02-11 01:48

developer   ~0018697

Latest has gnunet_log.py and payto.py documented:

- https://git.taler.net/taler-util.git/tree/doc

Moving on to talerconfig.py now...

ttn

2022-02-15 14:24

developer   ~0018698

talerconfig.py now documented:

- https://git.taler.net/taler-util.git/commit/?id=943817d37b8dcaf26771879c415e7a8841ec3e1a

@MS WDYT? There are four FIXMEs for which i would appreciate your comments.
(But any other feedback welcome, as well!)

ttn

2022-02-22 15:52

developer   ~0018709

Closing this bug since the docs are written and no one seems to have an opinion on where to put them.
For now, we'll just leave it in taler-util.git/doc/ for future reference.

Issue History

Date Modified Username Field Change
2020-11-17 17:29 MS New Issue
2020-11-17 17:29 MS Status new => assigned
2020-11-17 17:29 MS Assigned To => Stefan
2020-11-17 17:30 MS Target Version => 0.8.1
2020-11-17 17:30 MS Description Updated
2020-11-17 17:37 MS Assigned To Stefan => MS
2021-01-01 16:40 Christian Grothoff Note Added: 0017291
2021-01-07 04:10 ttn Note Added: 0017317
2021-01-07 09:42 Christian Grothoff Note Added: 0017319
2021-01-07 22:29 Christian Grothoff Severity minor => text
2022-02-10 07:58 ttn Note Added: 0018690
2022-02-10 09:11 Christian Grothoff Note Added: 0018691
2022-02-10 10:41 ttn Assigned To MS => ttn
2022-02-10 10:43 ttn Status assigned => feedback
2022-02-10 10:43 ttn Note Added: 0018693
2022-02-10 12:16 ttn Note Added: 0018694
2022-02-10 12:16 ttn File Added: .ttn.configure.log
2022-02-10 13:20 ttn Note Added: 0018695
2022-02-10 16:29 ttn Note Added: 0018696
2022-02-11 01:48 ttn Note Added: 0018697
2022-02-15 14:24 ttn Note Added: 0018698
2022-02-22 15:52 ttn Status feedback => resolved
2022-02-22 15:52 ttn Resolution open => fixed
2022-02-22 15:52 ttn Note Added: 0018709
2022-10-20 10:48 Christian Grothoff Target Version => 0.9
2022-11-04 20:52 Christian Grothoff Status resolved => closed