Bronotes
Basically a wrapper to access notes in a directory on your system anywhere from the commandline. And keep it in sync with git.
Functionality so far:
- Create a note directory on your system on first start
- Add new notes
- Remove notes
- Move notes and directories around
- Edit notes with your $EDITOR
- List notes dir in a tree
- Generate autocompletions for zsh
- Execute arbitrary commands in the notes directory
- The show and edit actions search for matching notes if no valid path is given
Installation
$ pip install bronotes
On first command a folder to be used is asked.
Completions
For now there's no built-in completions. ZSH completions can be generated so you can place them where needed:
$ bnote completions | tee ~/.oh-my-zsh/completions/_BRONOTES
Usage
By default this wraps any shell command you feed it and executes it in your notes directory. When using any of the defined actions (see bnote -h) it will do that instead. The default can be changed, and the regular shell alternatives for actions like 'rm' can be used by just using the 'exec' action manually.
$ bnote -h # For actions overview, actions have their own sub help-pages.
$ bnote list
.notes/
|-- baewfweiogn
|-- testblaat.md
|-- blarpblarp.md
$ bnote madness # madness is a great way to browse your markdown files in a local server
start the madness
env production
listen 0.0.0.0:3000
- Subcommands have their own help pages.
- When using the edit or show subcommand, it falls back on the -s option if the path to your note is not valid.
- If the first argument given is not recognized by bronotes, a default action will be taken and the first argument will be fed to that action instead. This is configurable with the 'set' action and defaults to 'exec'
Git
You can use the sync command to keep a repo in sync with git. Using basic pull/push on master. If you want to have more control simply don't use this. If the repo isn't a git repo yet you will be asked to initialize an empty one and set up remotes. When quit halfway through this process it's probably better to either start over or just fix it manually.
Autosyncing is possible, but will do so after every edit or add action. So figure out if you want that yourself.
1 maintainer
Metadata
1 maintainer
Release files for bronotes 2.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| bronotes-2.4.1.tar.gz | 12.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| bronotes-2.4.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 31.9 kB
Release files / bronotes-2.4.1.tar.gz
| Download URL | bronotes-2.4.1.tar.gz |
|---|---|
| Size | 12.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ac5e95517897b50a3b1ad5eeef4c5f9d48fac6a1e127990ce1d3d045d63164d5
|
|
BLAKE2b-256 checksum How to use checksums |
34c652b805e6e02818b196e72055f63cdeebd76beccf6af0dac2eda5c09247f4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5
|
Release files / bronotes-2.4.1-py3-none-any.whl
| Download URL | bronotes-2.4.1-py3-none-any.whl |
|---|---|
| Size | 19.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4e2548ecfc4fe5754acb363dbca5bb249c38aa32b656671cd850748744cc690b
|
|
BLAKE2b-256 checksum How to use checksums |
86e49f3208a6053e7f24f16f8cdcbd984a5530a9f637a27766e830fc59b3dee2
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5
|
