Package: take-note-cli
Take NoteCreate and open notes in your favourite editor.FeaturesWritten in Python with no runtime dependencies.Works on Python 3.8 - 3.11.Open notes files for specified week using thecodecommand line for VS Code.--thisWeek, --lastWeek and --nextWeek are supported.Organises notes in a date based folder structure from your root notes folder, e.g. 2023/08set the root notes folder using --notesFolderChoose which editor to use with --editorSpecify a VS Code workspace to open along with the note file with --workspaceThis will override the --editor setting tocodeSpecify a template file relative to the root notes folder to use when a new file is created using --template. This also performs a simple replacement of the text HEADER_DATE with the date formatted as "%A %d %B %Y" to use in the document title.Support for batch creation of files in advance. This is useful if you use a device where you can edit files, but can't easily create them. Use --batch 5 along with any of the --*Week options to create that week and the following 4 weeks too.Future featuresSupport for daily notes options.InstallationpipxThe recommended way to install the published package is throughpipx.# from PyPIpipxinstalltake-note-cli# direct from githubpipxinstallgit+https://github.com/wsinned/take-noteUsageCommand LineSpecify a folder using the --notesFolder option, otherwise $HOME/Notes will be used
A week option must be supplied from --thisWeek, --lastWeek or --nextWeektake-note--notesFolder=$HOME/MyNotes--thisWeekA note will be created in the under the MyNotes/YYYY/mm folder named with the date of the Monday of this week, e.g. 2023-08-07-Weekly-log.mdAliasesSetting up aliases in you preferred shell is a great way to make accessing your notes quick and easy.notes_folder="$HOME/SomePath/MyNotes"args="--notesFolder$notes_folder--workspace notes.code-workspace --template Home-weekly-log-template.md"aliasthisWeek="take-note --thisWeek$args"aliasnextWeek="take-note --nextWeek$args"aliaslastWeek="take-note --lastWeek$args"All you have to do now is type one of the following to open the desired note file.>thisWeek
>lastWeek
>nextWeekOther Installation MethodsVirtual Environmentpython-mvenvvenvsourcevenv/bin/activate

venv/bin/pipinstall-rrequirements.txt# install with tests as editable srcvenv/bin/pipinstall-e.DevelopmentNix & NixOSThe supplied shell.nix definition provides support for entering a nix-shell directly in the repository with all dependencies.nix-shell--runzsh# ensure using zsh over default bash session# only needed once, or to recreate the virtual environmentpython-mvenvvenvsourcevenv/bin/activate# install with tests as editable srcvenv/bin/pipinstall-e'.[test]'# run the testspytest# close the virtual environment and exit the shell when donedeactivateexitOther Linux or macOS# only needed once, or to recreate the virtual environmentpython-mvenvvenvsourcevenv/bin/activate

venv/bin/pipinstall-rrequirements.txt-rrequirements.dev.txt# install with tests as editable srcvenv/bin/pipinstall-e'.[test]'# run the testsvenv/bin/pytest# close the virtual environment when donedeactivateLintingThe project usesrufffor linting and optionally for formatting.venv/bin/ruff.--configpyproject.tomlBuild & PublishFrom an installed and tested venv, do the following:# check the version:catsrc/takenote/__version__.py# build the packagevenv/bin/pyproject-build# publish the packagevenv/bin/twineuploaddist/*Credentials for twine should be either:
- stored in .pypirc in the [pypi] section
- entered at the prompt, username =tokenand password = your_api_key