pyhistory 1.3

Note

This package is created to help maintaining history file in environment of high concurrency (literally: each pull request on GitHub had conflicts in HISTORY.rst file because it was updated before creating PR). Take into account it may NOT fit into your environment and/or workflow since it was cutted for specific case, but it’s good if so. :)

History directory

Pyhistory will traverse directory tree until it finds history file (by default HISTORY.rst, can be changed in setup.cfg, see section Config file) and this will be root, where history directory will be created, in which all entries will be stored. Thanks to that you can add, list or remove entries from any point in your project - all commands will be executed in context of root directory.

Features

(All commands can start either with pyhistory or pyhi.)

• Add history entry:

  $ pyhi add 'New feature'
  $ pyhi add Something

• List history entries:

  $ pyhi list
  
  * New feature
  * Something

• Update your history file with entries for given release:

  $ pyhi update 0.4.2

• Delete selected entries:

  $ pyhi delete
  
  1. New feature
  2. Something
  3. Another one
  4. Wrong one
  
  (Delete by choosing entries numbers.)
  
  $ pyhi delete 2 4
  $ pyhi list
  
  * New feature
  * Another one

• Clear all history:

  $ pyhi clear

• Config file:

  You can adjust Pyhistory behaviour to your needs by setup.cfg file. Just put pyhistory section in there:

  [pyhistory]
  history_dir = some_dir # 'history' by default
  history_file = myhistory.rst # 'HISTORY.rst' by default
  at_line = 42 # By default history will be injected after first header

History