Giter VIP home page Giter VIP logo

nota's Introduction

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.

nota's People

Contributors

ansys-ataylor avatar rats3g avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.