galvez/plainbudget

Minimalist Plain Text Budgeting

plainbudget: Minimalist Plain Text Budgeting

npm install pbudget -g

Latest library version is 0.2.8:

ESM

import { Plainbudget } from 'pbudget'

CommonJS

const { Plainbudget } = require('pbudget')

See http://galvez.github.io/plainbudget for details.

Library API badly needs docs, see src/components/Sheet.vue for now.

CLI

# reads and modifies file with result
pbudget sheet.txt -s 

# reads file and prints result
pbudget sheet.txt

# process from stdin and write to stdout
cat sheet.txt | pbudget > new-sheet.txt

Development

npm start # starts Nuxt development server
npm run build # builds SPA in docs/ folder

Requires Nuxt for running and building.

License

MIT

plainbudget's Issues

Choose storage mechanism (local and remote)

Currently there's no save functionality.

Add original Python CLI to codebase

Experiment with floating point numbers

Currently the parser is limited to parseInt() for simplicity.

It might be possible to enable parseFloat() rather easily.

Needs lots of testing.

Non-latin characters are not supported

If expense group is named in one of non-latin languages (cyrillic for example) references stop working.

Shared named group space for multiple sheets

Work on plug-in proposal

Things that could be added:

• A way to retrieve currency exchange rates and specify value currencies.
• Import and parse sheet values from remote sources.

Lots of room for discussion here.

Create npm-installable CLI

Add dynamic groups with variables

Refactor pages/index.vue into components/Sheet.vue

So that we can potentially have multiple sheet tabs in one page.

Income Groups, and or mixed sum groups

similar to expense groupings, would it make sense to also have income groupings or mixed project groupings?

examples:
Incomes:

= Incomes
+ 3400 paycheck
+ 50 credit card return
= $totalIncomes

Mixed:

= Rock pit
- 300 pea gravel
- 20 ground cover
+ 15.50 sold old grill
+ 50 misc craigslist sales
= $projectSum

I guess the confusion here might be in how the result of a mixed value is represented, as its sum could be + or -. Maybe => Rock pit would return the sum, positive or negative...?

= 3450 Incomes
=> -254.5 Rock Pit
= 3195.5

Thoughts on adding dates per entry

I'd love to be able to add dates to each entry so I can plan a month out. Thoughts?

Cannot GET /

For some reason when I pull this down and run the dev server on my personal Mac it keeps giving me an error on localhost:3000. Is this due to the nuxt.config.js router path being incorrect? Silly question, a bit new to vue/nuxt so just let me know if you have some insight.

Fix named group multipliers

Fix bug with multiplier feature

For some reason parseMultiplier doesn't seem to be working.