nota
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
Install nota with:
pip install rats3g-nota
Run nota and list possible arguments using:
nota -h
Configuration
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 |
Development
To get started with nota development, clone the Git repository
git clone https://github.com/pyscaffold/pyscaffold.git
Install development dependencies using pip
pip install -r requirements.txt
Finally, setup nota for development with the usual
python setup.py develop
and you are ready to go. Any changes you make will be reflected when you run nota.
1 maintainer
Release files for rats3g-nota 0.1.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| rats3g-nota-0.1.3.tar.gz | 7.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| rats3g_nota-0.1.3-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 14.3 kB
Release files / rats3g-nota-0.1.3.tar.gz
| Download URL | rats3g-nota-0.1.3.tar.gz |
|---|---|
| Size | 7.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
3c68ceac0d106bb807bcf2a73f5d9c0a36597459f77a9bdd9f7420c0f982f37c
|
|
BLAKE2b-256 checksum How to use checksums |
9193215ce8ed217bb976a5c658a1284bc71b9be70f65bf236a983c690e253c07
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.4
|
Release files / rats3g_nota-0.1.3-py2.py3-none-any.whl
| Download URL | rats3g_nota-0.1.3-py2.py3-none-any.whl |
|---|---|
| Size | 7.1 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
a5d3e7cecd263daab139b6471aa451f4fb0308cd40996420f45ddae5c42e1534
|
|
BLAKE2b-256 checksum How to use checksums |
53ba6b8ccf25394f2b58080d27550c33699d845c6d350fbca5a072fefca096c1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.4
|
