v3 installation, testing, docs

[Eric Altendorf]

https://github.com/beancount/beancount?tab=readme-ov-file

still says v3 is unstable and kinda suggests using v2 as the "current" stable version.  I recommend making it clearer that v3 is the default current version to use now, and remarking that some 3rd party systems (e.g. fava) may require use of the old otherwise deprecated v2.

That page also links to this document for installation instructions:

http://furius.ca/beancount/doc/install

but this is also for v2.  Is there a v3?

It also links to this as canonical documentation:

https://beancount.github.io/docs/

which also has these installation instructions, which reference v2:

https://beancount.github.io/docs/installing_beancount.html

One comment is that I think these are confusing for new users (it was certainly confusing to me when I first arrived here whether v2 or v3 was recommended, and I frequently found myself accidentally referencing docs for the wrong version)

Second is a question, for me specifically right now I'd like to revisit my cost-basis PR, which means I'd like to get beancount set up in dev mode where I can make changes and run the test suite.  What's the right way to do this?

[Eric Altendorf]

Oh, I forgot, I think I mentioned this before, but the v2 install doc:

https://beancount.github.io/docs/installing_beancount.html

links to a supposed v3 install doc at this url:

https://beancount.github.io/docs/installing_beancount_v3.md

however that's a 404.

[Martin Blais]

Thanks for pointing out doc updates need Eric, I'll fix those when I can find some time.

--
You received this message because you are subscribed to the Google Groups "Beancount" group.
To unsubscribe from this group and stop receiving emails from it, send an email to beancount+...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/beancount/CAFXPr0u5LET3DUMyTntrZ3XX2oc7PMRAZ5tzUipOzJS-4K33Tw%40mail.gmail.com.

[Martin Blais]

On Tue, Jun 25, 2024 at 4:23 PM Eric Altendorf <erical...@gmail.com> wrote:

Second is a question, for me specifically right now I'd like to revisit my cost-basis PR, which means I'd like to get beancount set up in dev mode where I can make changes and run the test suite.  What's the right way to do this?

set PYTHONPATH

"make test"

"make lint"

Old skool :-)

 

[Martin Blais]

All errors above addressed.  The .io site will be updated eventually.

[Eric Altendorf]

awesome thanks :)  will try to get a more serious PR for the cost-basis stuff ready for comment soon.

To view this discussion on the web visit https://groups.google.com/d/msgid/beancount/CAK21%2BhPaEEVE07iATDAx%2B_uVicZhhXKKU82Ma%2B0znLLJwpmuAw%40mail.gmail.com.

[Stefano Zacchiroli]

On Mon, Jul 22, 2024 at 09:28:47PM -0400, Martin Blais wrote:
> All errors above addressed. The .io site will be updated eventually.

Not sure if this is related to the change you mention, but I just
noticed (after pointing a friend to Beancount for the first time) that
the homepage at https://beancount.github.io/ still says:

> Version 3 (branch: master): The in-development next version of
> Beancount since June 2020. This is unstable and you want to use
> version 2 below. The scope of changes is described in this document.

Cheers
--
Stefano Zacchiroli . za...@upsilon.cc . https://upsilon.cc/zack _. ^ ._
Full professor of Computer Science o o o \/|V|\/
Télécom Paris, Polytechnic Institute of Paris o o o </> <\>
Co-founder & CTO Software Heritage o o o o /\|^|/\
https://twitter.com/zacchiro . https://mastodon.xyz/@zacchiro '" V "'

[Eric Altendorf]

Thanks for updating the docs, this was helpful.  A few suggestions and then one question where I'm stuck:

pip, as a general pattern, gets itself confused very easily and your state of deps can get corrupted.  Having one global system-wide state which you update by running `sudo pip` is a recipe for misery.  These days I *never* run pip outside of a venv that I can toss and start fresh easily.  I would recommend those instructions (also then you don't need sudo access).

For "Installing for Development", can't you just use `pip install -e` ?

I personally would recommend making other packages (like pytest) that are only needed for development part of the dependency list anyway.  The python install process should simply be git clone, create venv, pip install [-e]; IMHO the project should be set up so that just works.

It didn't seem to break my install, but the top of your makefile contains your personal paths:

INPUT = $(HOME)/q/office/accounting/blais.beancount
DOWNLOADS = $(HOME)/u/Downloads

However, I'm now running into the issues discussed on this thread:

https://groups.google.com/g/beancount/c/7ppbyz_5B5w/m/YlHiKhynFAAJ?pli=1

In particular, running `make test` shows all tests failing with errors of the form

ERROR beancount/core/account_test.py - FileNotFoundError: [Errno 2] No such file or directory: '/tmp/pip-build-env-urgb73ml/normal/bin/ninja'

According to that thread, the solution is to install ninja (if so, that should be added to the docs, I guess).  However, I still get the same errors after installing ninja in the venv.  I also tried installing meson and meson-python for good measure, still no go.  It's not clear to me from that thread whether meson is used or required.

 

--
You received this message because you are subscribed to the Google Groups "Beancount" group.
To unsubscribe from this group and stop receiving emails from it, send an email to beancount+...@googlegroups.com.

To view this discussion on the web visit https://groups.google.com/d/msgid/beancount/CAK21%2BhM8fiP0MU06er%3DiCv-HsED37xSt5J3m-e-hdq-E5t3Lag%40mail.gmail.com.