Skip to content
This repository was archived by the owner on Dec 14, 2025. It is now read-only.

4sp1/bb_time_historic

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

43 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

bb-time

Brainy Bot "Time"

Try Zellij! It's written with love and reason for you if you like terminals and Rust too. You don't need Rust yet and if you are already a Rustaceans, you're welcome to join us.

Try (you will need: zellij, podman-desktop intialized an vm running or podman linux)

go run github.com/4sp1/bb-time/cmd/zellij-kdl-gen -json runtime.json

Oups, first: runtime.json

{ "DatabaseRoot": "/Users/malikbenkirane/Downloads/podv", "DatabaseDir": "bb.sdb", "AuthID": 718330459, "TestToken": "...secret...", "TestNamespace": "alpha", "DeployToken": "...secret...", "DeployNamespace": "alpha2" }

You are ready: a few steps to get used to [zellij]

zellij -l zellij/layout.kdl

There is an old merge request from a dear friend I want to feature now because what you've just read is not the only way to get to join people who want to help there work. Work is far away from labor and strong thaughts saying work is the condition for the world for us!

@t4ke0 PR #14

Setup

  • set variable BBTIME_TG_TOKEN
  • set variable BBTIME_AUTHID (if you don't know your user ID
    • try first with "0" and check logs to get your user ID
    • restart the bot with the ID you want to use
  • configure the persistence see notes below
go run github.com/4sp1/bb-time/cmd/service

CLI

$ eval $(go run github.com/4sp1/bb-time/cmd/cli -podman)
$ go run -reset -ns ${sdb_namespace} $ go run -l -p -c # print logs, postponed, closed

Roadmap

You are about to read a deprecated, fast evolving roadmap You could better use your time with documenting /issues

TODO(malikbenkirane) (rewrite)

This is the flow you would get talking with timer bot

timer bot flow

Current alpha

  • Any message will start a new record
  • Commands
    • /resume resume current record
    • /close close current record
    • /break pauses current record
  • Persistence layer is using SurrealDB
    • defaults to user=root and pass=root
    • defaults to ns=test and db=tbot (I use ns alpha for test and alpha2 replaces test)
    • tuning with env variables BBTIME_SDB_{USER,PASS,NS,DB}
    • podman or docker run -p 8000:8000 surrealdb/surrealdb start
    • configure volume and trace options here
  • Records: keep track of stated records
  • Logs: keep track of breaks and closed records
  • Only manual testing at the moment

Looking forward to

  • alpha milestone!
  • Track postponed records
  • Sync with your calendar
  • List and export your logs (breaks, postpones, closings) and records
  • Smart error handling (commit, rollback style)
  • Continuous deployment
  • Unit and integrations tests

Rise Science

The power behind your next best day

We are looking forward to put in place a light version of Rise predictive system on your daily cycles and add more inputs in a less bloated interface.

Some useful links

Contributing

  • see open and closed issues and feel free to open new issues, this include
    • feature requests (label:enhancement)
    • bugs
    • ux suggestions (label:ux)
    • ask general questions or technical questions
    • upload things you consider invalid (label:invalid)
    • etc.. feel free to submit anything, issues are like our forum :)
  • see pull requests
    • feel free to review any pull requests, we would be happy to help you progress
    • we are also happy to progress and to learn from your comments
    • leave review and comments even if the pull requests were merged an closed
  • software engineering is a passion for us, please help us developping our passion
  • feel free to submmit pull requests for these contribution short points
  • let's try to always improve and keep us gathered in a good mood
  • things should'nt work, we do our best to make them work!
  • commit messages we would love to see [target] [action] [msg] because we think it's easier to read them this way.
  • TODOs, XXXs and FIXMEs can be followed with (from[:to]) assignation or demand with your respective pseudos if you search these symbols (e.g. with rg) you will only find them here and in your copy of the files
  • from and to can also take the reserved value any to designate anyone

About

Brainy Bot "Time"

Resources

License

Stars

Watchers

Forks

Packages

No packages published