Skip to main content

A scaffolding program for developer notes.

Project description


nota is a scaffolding tool for developer notes. Out of the box, nota provides sensible defaults for common development scenarios - defects, stories, bugs, and features. nota promotes productive notetaking habits and allows for customization to accommodate unique workflows.


Install nota with:

pip install rats3g-nota

Run nota and list possible arguments using:

nota -h


nota supports configuration using command line parameters and a JSON config file. Precedence is: command line -> config file -> internal defaults.

Option Command Line Config Variable
Generate bug template -b --bug bug.* $option
Set custom configuration file -c --config
Generate defect template -d --defect defect.* $option
Use custom list of directories --directories *.directories[]
Generate feature template -f --feature feature.*
Set note filename --filename *.filename
Print help information -h --help
Set note unique ID --identifier $id
List available notes -l --list
Create note <NAME> $name
Generate custom template -o --option $option.* $option
Set root directory for notes -r --root root $root
Generate story template -s --story story.* $option
Use custom template for note -t --template *.template
Print version information -v --version


To get started with nota development, clone the Git repository

git clone

Install development dependencies using pip

pip install -r requirements.txt

Finally, setup nota for development with the usual

python develop

and you are ready to go. Any changes you make will be reflected when you run nota.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rats3g-nota-0.1.3.tar.gz (7.2 kB view hashes)

Uploaded source

Built Distribution

rats3g_nota-0.1.3-py2.py3-none-any.whl (7.1 kB view hashes)

Uploaded py2 py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page