Git Product home page Git Product logo

nb's Introduction

nb

nb (nota bene) is a tool for recording data over time. what sets nb apart is that:

  • it's a scrappy, easy to use CLI that gracefully scales to automated workflows
  • it's opinionated about use cases and provides "recipes" for them

why did i write nb? in my head, all tasks that take longer than one sitting take the same amount of time to complete: infinite. if i'm to do a task that is large, i need to be able to see progress. this is particularly hard for tasks where your work is routinely being undone.

domain model

nb is concerned with several types of things. the first is a stream. streams are containers for different types of data. one stream might contain the number of unread emails in your inbox, another might contain the number of pages you've written in a day, etc.

streams are built of notes. a note is a thruple in the format (index, timestamp, value), and is a record of some thing at some time. most notes will be numbers; do not be concerned by this. they are called notes because you note them, not because they are long-form text.

workflow

start by identifying something you think might be useful to measure. measure it a few times, recording these measurements with nb in a stream. if you find yourself referring back to the measurements, automate gathering them. if you do not, delete the stream; nb is a tool for collecting data that helps you do some thing.

recipes

a goal with ups and downs, or a goal with incoming and outgoing work

if you have a goal on something easily measured, consider this recipe. make a stream for the task, and measure and note its value any time you think about it or make progress towards it.

technical

where is the data stored

data is stored locally in a flat json database; by default, it's named database.db. if you would like to sync it, use the tool of your choice. the author recommends syncthing.

nb's People

Contributors

echo-bravo-yahoo avatar mynockspit avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

mynockspit

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.