noqqe / cmddocs

An interactive commandline interface for your personal docs using python, Cmd, git and markdown

Hi there 👋

cmddocs's Issues

Implement Diff

'log' command crashes program if git isn't configured

Error Message:

wiki> log
Last 10 commits
Traceback (most recent call last):
  File "/usr/local/bin/cmddocs", line 9, in <module>
    load_entry_point('cmddocs==0.10.6', 'console_scripts', 'cmddocs')()
  File "/usr/local/lib/python2.7/dist-packages/cmddocs/__init__.py", line 249, in main
    Cmddocs().cmdloop()
  File "/usr/lib/python2.7/cmd.py", line 142, in cmdloop
    stop = self.onecmd(line)
  File "/usr/lib/python2.7/cmd.py", line 221, in onecmd
    return func(arg)
  File "/usr/local/lib/python2.7/dist-packages/cmddocs/__init__.py", line 184, in do_log
    show_log(args,self.repo)
  File "/usr/local/lib/python2.7/dist-packages/cmddocs/articles.py", line 244, in show_log
    print(repo.git.log(pretty=format, n=count,date=dateformat))
  File "/usr/local/lib/python2.7/dist-packages/git/cmd.py", line 440, in <lambda>
    return lambda *args, **kwargs: self._call_process(name, *args, **kwargs)
  File "/usr/local/lib/python2.7/dist-packages/git/cmd.py", line 834, in _call_process
    return self.execute(make_call(), **_kwargs)
  File "/usr/local/lib/python2.7/dist-packages/git/cmd.py", line 627, in execute
    raise GitCommandError(command, status, stderr_value)
git.exc.GitCommandError: 'git log --date=short --pretty=format:%C(blue)%h %Cgreen%C(bold)%ad %Creset%s -n10' returned with exit code 128
stderr: 'fatal: bad default revision 'HEAD''

Quick Start Config not working - Missing Section "Colors"

Using the Quick Start Config from the readme results in an error:
The Section "Colors" is needed.

Implement version command

Feature Request: Color option for headlines

in view H1 and H2 are shown in light gray. With a bright terminalbackground like white the color formatted headlines are nearly unreadable. Basically a color option only needs only 2 arguments: light or dark. Awesome color option will allow integers 0..255

Replace try,excepts with default config

At the moment i have a huge amount of try and excepts in config parsing phase of cmddcos.

Easier, and a lot more readable, would be to have a default config

(possibly sane) configuration defaults

Currently, you can't use cmddocs without a complete configuration. It should be possible to configure just a few options, such as Datadir and assume a sane fallback unspecified configuration options.

Also, I suggest to use lowercase sections and configuration options. It is (at least for me) very uncommon to have capitalized configuration options.

Edit: sections are case-insensitive, so it doesn't really matter...

Feature Request/Enhancement: add option for file-extensions (i.e. *.md)

It could be useful to have the option to append a file-extension to the filenames.

Benefits:

• While editing editors can use syntax-highlighting (via syntax)
• For viewing editors can be used as pager with syntax-highlighting
• Converting to other formats is easier (i.e. pandoc)
• Formatted viewing of files is possible with other devices (i.e. on Android with MdReader)

Implement Tags

Catch error when excuted without valid config

Using "mail" without parameter crashes cmddocs

Make search function capable of also finding strings in filenames

Find a way to store meta data on articles.

Metadata. Metadata kills people.
Anyways.

There should be a way to store tags, dates, headlines or other stuff

In markdown blog engines it most of the time looks something like this

---
tags:
- foo
- bar
title: foo

---

Sadly thats not part of the parser misaka.

Another option would be to implement a separate store for meta data. Like sqlite, a json file, something else serialized on disk. Would be nice to handle, but its not in the concept of the "flat file design" that this projects goal is.

editorflags

Also allow flags for editor

Implement "info" command

That shows something like

            Created: 2014-01-18 11:18:03 +0100
            Updated: 2015-10-23 14:14:44 +0200
            Commits: 26
            Lines: 116
            Words: 356
            Characters: 2438

When cancelling adding a document, cmddocs crashes

Steps to reproduce:

1. edit new document
2. Cancel Editor without saving

Be compatible with python3

Configurable Colors

Fix issue with Multiple Codeblock Highlightning

Add tree ad dependency in Documentation and Configurable path

"mail this" action

To be able to simply mail a specific article to someone.

Pip install fails on Manjaro

Error message below:

[knatterton@desktop ~]$ pip install cmddocs
You are using pip version 7.0.1, however version 7.0.3 is available.
You should consider upgrading via the 'pip install --upgrade pip' command.
Collecting cmddocs
Downloading cmddocs-0.10.5.tar.gz
Collecting gitpython (from cmddocs)
Downloading GitPython-1.0.1.tar.gz (355kB)
100% |████████████████████████████████| 356kB 867kB/s
Collecting configparser (from cmddocs)
Downloading configparser-3.3.0r2.tar.gz
Complete output from command python setup.py egg_info:
Traceback (most recent call last):
File "", line 3, in
File "/usr/lib/python3.4/site-packages/setuptools/init.py", line 4, in
import distutils.core
File "/usr/lib/python3.4/distutils/core.py", line 18, in
from distutils.config import PyPIRCCommand
File "/usr/lib/python3.4/distutils/config.py", line 7, in
from configparser import ConfigParser
File "/tmp/pip-build-xcfns1yl/configparser/configparser.py", line 397
_KEYCRE = re.compile(ur"%(([^)]+))s")
^
SyntaxError: invalid syntax

----------------------------------------

Command "python setup.py egg_info" failed with error code 1 in /tmp/pip-build-xcfns1yl/configparser

Switch to termcolor

termcolor is a library which does all the pretty printing and stuff. Instead of doing it myself.

{feature-request}{bug}Pager Options

Bug:
If I change the setting Pager in ~/.cmddocsrc to:
Pager = some_prg
then viewing inside cmddocs fails with:
/path/to/some_prg: bad option '-fr'

Related feature request:
Add an option to set Pager_Options in the config-file to override hardcoded -fr-Options in:

cmddocs/cmddocs/articles.py

Line 162 in c35d41e

subprocess.call([pager, "-fr", tmp.name])

Make tree path configurable

Implement stats

With

• Overall character/line/word/article/directory/commit count
• edit graph

Implement Revert