The Beancount documentation is now complete.
I had to work through a *lot* of procrastination to get there :-)

I'd like to do a few things before releasing a 2.0 version and move to
semantic versioning thereafter.
These may affect you, especially if you're packaging an installation.
Please let me know ASAP if any of these is going to have any material
impact on what you do (I don't think but I prefer to send a heads-up).

- I'd like to move "src/python/beancount/" to just a "beancount/"
subdirectory under the root, to follow well-worn conventions in the Python
community. Let me know if this makes sense to you. My source code was
located where it is now from an old convention I've had for private
repositories which support multiple programming languages and I realize it
is somewhat unusual. This project is popular enough at this point (we have
122 people on the list) I should try to make it conform to what most people
expect from a Python package before the release. This also means the Emacs
support file (beancount.el) will move somewhere else.

- The beancount.projects.returns code that computes investment returns was
put out there a long time ago, but it had some remaining flaws that made it
difficult to use and especially difficult if not impossible to debug.
Because of this, I doubt anyone uses it (but I can't know for sure). A long
time ago I began to rewrite it and fix those issues but that work fell by
the wayside and now still lives in a branch ("returns2"), sitting there
incomplete. I'd like to clean things up by removing the script and moving
this rewrite to experiments/ until I have time to complete this, where it
belongs. If you're using beancount.projects.returns and it works for you,
please let me know right away (and I'll be really surprised).

- I'll move out codes that are used for development from beancount.* into
tools/. This includes everything under src/python/beancount/docs,
beancount.scripts.example, and beancount.scripts.tutorial. I don't think
this should affect anyone. These don't belong in the main codebase, as they
should not need to be invoked by users.

Other tasks that will be done before the release are:
- Complete small refactoring for conversions to cost basis and market value
- Fix issue #145
- Write some code to download and convert documentation from GDocs to
markdown for inclusion in Dominik Aumayr's generated docs (
http://aumayr.github.io/beancount-docs-static/).

-- 
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 [email protected].
To post to this group, send email to [email protected].
To view this discussion on the web visit 
https://groups.google.com/d/msgid/beancount/CAK21%2BhNrm7B5BEaSRhg-RVRVXN51jC9hSdjjovboix2Yr1d9fQ%40mail.gmail.com.
For more options, visit https://groups.google.com/d/optout.

Reply via email to