diff --git a/.gitignore b/.gitignore index 4812bbd..b939719 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ dist/ *.pyc .tox .coverage +docs/_build diff --git a/README.rst b/README.rst index 7823fdb..ff37a60 100644 --- a/README.rst +++ b/README.rst @@ -1,14 +1,17 @@ .. image:: https://travis-ci.org/Kraymer/qifqif.svg?branch=master - :target: https://travis-ci.org/Kraymer/qifqif + :target: https://travis-ci.org/Kraymer/qifqif .. image:: https://coveralls.io/repos/Kraymer/qifqif/badge.svg - :target: https://coveralls.io/r/Kraymer/qifqif + :target: https://coveralls.io/r/Kraymer/qifqif .. image:: http://img.shields.io/pypi/v/qifqif.svg - :target: https://pypi.python.org/pypi/qifqif + :target: https://pypi.python.org/pypi/qifqif +.. image:: https://readthedocs.org/projects/qifqif/badge/?version=latest +:target: http://qifqif.readthedocs.org/en/latest/?badge=latest +:alt: Documentation Status qifqif ====== - /kĭf kĭf/ + /kĭf kĭf/ 1. *adj. inv.* arabic slang (كيف) for "it's all the same". 2. *n.* CLI tool for *categorizing* qif files. It can make all the difference. @@ -40,8 +43,8 @@ Features completion - **Auditing mode:** review your transactions one by one - **Batch mode (no interactive):** for easy integration with scripts -- **Easy-going workflow:** dreading the behemoth task of importing years of - accounting from a single file? Don't be. Go at your own pace and press +- **Easy-going workflow:** dreading the behemoth task of importing years of + accounting from a single file? Don't be. Go at your own pace and press ```` to exit anytime. On next run, editing will resume right where you left it. @@ -50,13 +53,13 @@ Usage :: - usage: qifqif [-h] [-a] [-c CONFIG] [-d | -o DEST] [-b] [-v] QIF_FILE + usage: qifqif [-h] [-a] [-c CONFIG] [-d | -o DEST] [-b] [-v] QIF_FILE Enrich your .QIF files with tags. See https://github.com/Kraymer/qifqif for - more infos. + more infos. positional arguments: - QIF_FILE .QIF file to process + QIF_FILE .QIF file to process optional arguments: -h, --help show this help message and exit @@ -70,9 +73,9 @@ Usage -b, --batch-mode skip transactions that require user input -v, --version display version information and exit -More infos on the `wiki`_ page +More infos on the `documentation`_ website. -.. _wiki: https://github.com/Kraymer/qifqif/wiki +.. _documentation: http://qifqif.rtfd.org Installation @@ -82,7 +85,7 @@ qiqif is written for `Python 2.7`_ and is tested on Linux, Mac OS X and Windows. Install with `pip`_ via ``pip install qifqif`` command. -If you're on Windows and don't have pip yet, follow +If you're on Windows and don't have pip yet, follow `this guide`_ to install it. .. _Python 2.7: ttps://www.python.org/downloads/ diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..e5549a9 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,183 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + @echo " coverage to run coverage check of the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/qifqif.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/qifqif.qhc" + +devhelp: + $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp + @echo + @echo "Build finished." + @echo "To view the help file:" + @echo "# mkdir -p $$HOME/.local/share/devhelp/qifqif" + @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/qifqif" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +coverage: + $(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage + @echo "Testing of coverage in the sources finished, look at the " \ + "results in $(BUILDDIR)/coverage/python.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/_static/logo.png b/docs/_static/logo.png new file mode 100644 index 0000000..aa813f2 Binary files /dev/null and b/docs/_static/logo.png differ diff --git a/docs/_static/logo_idle.png b/docs/_static/logo_idle.png new file mode 100644 index 0000000..7bf6543 Binary files /dev/null and b/docs/_static/logo_idle.png differ diff --git a/docs/qifqif_demo.gif b/docs/_static/qifqif_demo.gif similarity index 100% rename from docs/qifqif_demo.gif rename to docs/_static/qifqif_demo.gif diff --git a/docs/_templates/sidebarfooter.html b/docs/_templates/sidebarfooter.html new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/docs/_templates/sidebarfooter.html @@ -0,0 +1 @@ + diff --git a/docs/_templates/sidebarintro.html b/docs/_templates/sidebarintro.html new file mode 100644 index 0000000..122e10d --- /dev/null +++ b/docs/_templates/sidebarintro.html @@ -0,0 +1,4 @@ +

+ qifqif is a robust CLI tool that categorize your transactions using his + flawless memory. +

diff --git a/docs/changelog.rst b/docs/changelog.rst new file mode 100644 index 0000000..b0a4f88 --- /dev/null +++ b/docs/changelog.rst @@ -0,0 +1,6 @@ +Changelog +========= + +Available on `Github Releases page`_. + +.. _Github Releases page: https://github.com/Kraymer/qifqif/releases diff --git a/docs/cli.rst b/docs/cli.rst new file mode 100644 index 0000000..17dc591 --- /dev/null +++ b/docs/cli.rst @@ -0,0 +1,25 @@ +CLI usage +========= + +:: + + qifqif.py [-h] [-a | -b] [-c CONFIG] [-d | -o DEST] [-v] QIF_FILE + +qifqif inserts a ``L your_category`` line for each transaction +of given QIF_FILE based on your existing matching history stored in CONFIG. + +Optional flags: + +- ``-a, --audit``: turn it on if you want to inspect every processed transaction + and category that got applied. Mutually exclusive with ``--batch`` mode as it + pause the process after each transaction. +- ``-b, --batch``: in this mode, transactions that validate a registered match + are assigned a category but others are left untouched (no interactive prompt) +- ``-c, --config``: by default, available categories and their matchings are + saved in ``~/.qifqif.json``. You can choose too to have different config + files eg one per family member. +- ``-d, --dry-run``: print the result of qifqif work on the standard output + only, leaving the qif file untouched. Mutually exclusive with ``--output`` +- ``-o DEST, --output``: by default input file is edited in-place. Use that + switch to write in another output file instead. +- ``-v, --version``: display version information and exit diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..d7db02d --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,297 @@ +# -*- coding: utf-8 -*- +# +# qifqif documentation build configuration file, created by +# sphinx-quickstart on Wed Jan 6 23:14:20 2016. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import subprocess +import alabaster + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = ['alabaster'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'qifqif' +copyright = u'2016, Fabrice Laporte' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = subprocess.check_output( + ['git', 'describe', '--abbrev=0', '--tags']).strip()[1:] +# The full version, including alpha/beta/rc tags. +release = '0.5.1' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +#today = '' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all +# documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +#keep_warnings = False + + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +html_theme_options = { + 'github_user': 'kraymer', + 'github_repo': 'qifqif', + 'github_type': 'watch', + 'travis_button': False, + 'codecov_button': False, + 'show_related': True, +} + +# Add any paths that contain custom themes here, relative to this directory. +html_theme_path = [alabaster.get_path()] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +html_title = 'plop' + +# A shorter title for the navigation bar. Default is the same as html_title. +html_short_title = 'yoyoma' + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +html_logo = '_static/logo.png' + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Add any extra paths that contain custom files (such as robots.txt or +# .htaccess) here, relative to this directory. These files are copied +# directly to the root of the documentation. +#html_extra_path = [] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +#html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +html_sidebars = { + '**': [ + 'about.html', + 'sidebarintro.html', + 'navigation.html', + 'relations.html', + # 'searchbox.html', + 'donate.html', + 'sidebarfooter.html', + ] +} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +#html_domain_indices = True + +# If false, no index is generated. +#html_use_index = True + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' +#html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +#html_search_options = {'type': 'default'} + +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +#html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'qifqifdoc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', + +# Latex figure (float) alignment +#'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + ('index', 'qifqif.tex', u'qifqif Documentation', + u'Fabrice Laporte', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'qifqif', u'qifqif Documentation', + [u'Fabrice Laporte'], 1) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'qifqif', u'qifqif Documentation', + u'Fabrice Laporte', 'qifqif', 'One line description of project.', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + +# If true, do not generate a @detailmenu in the "Top" node's menu. +#texinfo_no_detailmenu = False diff --git a/docs/getting_started.rst b/docs/getting_started.rst new file mode 100644 index 0000000..7dc3cd2 --- /dev/null +++ b/docs/getting_started.rst @@ -0,0 +1,81 @@ +Getting started +=============== + +.. |br| raw:: html + +
+ +Install +------- + +qiqif is written for `Python 2.7`_ and is tested on Linux, Mac OS X and +(somewhat) Windows. + +Install with `pip`_ via ``pip install qifqif`` command. +If you're on Windows and don't have pip yet, follow +`this guide`_ to install it. + +To install without pip, download qifqif from `its PyPI page`_ and run ``python +setup.py install`` in the directory therein. + +.. _Python 2.7: ttps://www.python.org/downloads/ +.. _pip: https://pip.pypa.io/en/stable/ +.. _this guide: https://pip.pypa.io/en/latest/installing/ +.. _here: https://github.com/Kraymer/qifqif/releases +.. _its PyPI page: http://pypi.python.org/pypi/qifqif#downloads + +The best way to upgrade is by running ``pip install -U qifqif``. |br| +A `RSS feed`_ allowing to hear about delivery of new releases is yet to come. + +.. _RSS feed: https://github.com/Kraymer/qifqif/issues/40 + + +How it works +------------ + +qifqif augment your qif files by adding a category line for each transaction, +that additional information can then be used by accounting software to +perform automatic QIF imports. + +It picks categories by searching for keywords you previously defined in +transactions fields and by repeating choices you made regarding similar +transactions. + +Learning as time goes by +^^^^^^^^^^^^^^^^^^^^^^^^ + +On first run, qifqif starts with an empty configuration file and prompt you to +enter a category and corresponding keywords for each transaction it reads. + +The mappings you enter at prompts are saved in the configuration file which +builds up upon the time as you use the software, allowing qifqif to tag always +more transactions automatically. + +.. note:: + While not recommended, it's possible to mass-edit the configuration file in + a text editor. Typically, the goal would be to add matchings in bulk and + speed up qifqif learning process as a consequence. |br| + See explanations about the `configuration file format`_ if you want to go + that way. + +.. _configuration file format: http://qifqif.readthedocs.org/en/latest/tips.html#format-of-the-configuration-file + +Entering keywords +^^^^^^^^^^^^^^^^^ + +The main interaction you will have with qifqif consist to enter a category and +keywords that are required for the transactions to belong to that category. + +Entering a category is pretty basic: it can be any string of your choice, use +```` completion to reuse existing ones. |br| +For a software like Gnucash, that info must correspond to the account name you +want the transaction to be attached to. + +Entering keywords has a more advanced interface. |br| +Basic & simple case: you enter (successive) word(s) present in the *Payee* field of the current transaction. |br| +If you are interested to detect transactions on field(s) other than *Payee*, +using partial words matching or --foul you!-- using regexes, then please read +`mastering keywords`_. + +.. _mastering keywords: http://qifqif.readthedocs.org/en/latest/tips.html#mastering-keywords-prompts + diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..ec0d3fe --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,30 @@ +qifqif: enrich your .qif files with categories +============================================== + +Welcome to the documentation for qifqif, the CLI tool that alleviate the chore +of pairing your financial transactions with categories/accounts. + +Be sure to read the :doc:`/getting_started` guide that walks you through the install +and expose the basic operation. + +Qifqif is dead simple but check the :doc:`/cli` and :doc:`/tips` to +get the know-how of some advanced usages. + +And if you still need help, don't hesitate to send me a mail +(````) or `file a bug`_ in the issue +tracker. + +.. _file a bug: https://github.com/Kraymer/qifqif/issues + + +Contents +-------- + +.. toctree:: + :maxdepth: 2 + + getting_started + cli + tips + changelog + diff --git a/docs/match_colors.png b/docs/match_colors.png deleted file mode 100644 index 43255e2..0000000 Binary files a/docs/match_colors.png and /dev/null differ diff --git a/docs/pip-requirements.txt b/docs/pip-requirements.txt new file mode 100644 index 0000000..fd76d47 --- /dev/null +++ b/docs/pip-requirements.txt @@ -0,0 +1 @@ +# Requirements file for readthedocs.org diff --git a/docs/tips.rst b/docs/tips.rst new file mode 100644 index 0000000..e4078fd --- /dev/null +++ b/docs/tips.rst @@ -0,0 +1,76 @@ +Advanced tips +============= + +.. |br| raw:: html + +
+ +Mastering keywords +^^^^^^^^^^^^^^^^^^ + +Two methods of keywords inputs are available. You switch from one to the +other by pressing ```` when presented with a match prompt : + +- **payee (full match)** : it's the default method. The keywords must consist + of successive words present in the payee field. +- **any field (partial match)** : you are first asked to enter a field and then a + substring to search on this field content. Unlike default full words match, + the substring is used as-is thus enabling creation of rules based on partial + word match. Append a ``*`` character when entering the field name to + unlock the regex input method. |br| + The two-steps prompt is repeated so you can combine rules on multiple fields. + Enter no char at prompt to validate the set of rules. + + + +Json configuration file format +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +.. warning:: + Editing this file manually is not recommended, as any formatting error will + make the program exit on error. + +Matchings are saved automatically by qifqif as a json dict. +Keys are the categories, the values are their associated keyword(s). + +As an example, here is a valid file defining two categories named *Clothes* +and *Bank accounts* : :: + + { + "Clothes": [ + "REEBOOK", + { "payee": "NIKE", "filename": "BOB"} + ], + "Bank accounts": [ + "10203586133", + { "payee": r"FR\d+"} + ] + } + +Some comments : + +- for the sake of readability, payee keywords -- because they are so common -- + are stored as string. It's just a formatting shortcut, ``REEBOOK`` can be + written as ``{"payee": "REEBOOK"}`` with no difference whatsoever + +- when many keywords expressions match an input transaction, the longer one + (by number of fields involved and lengthwise) is selected. + + +Editing/removing existing data +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +At match prompt, press twice ```` if you don't want to store a match for +a given transaction. + +Enter a match containing only space(s) to undo and go back to edit category +prompt. + +Save or discard? +^^^^^^^^^^^^^^^^ + +Automatic saves allow you to import a large file in multiple runs. +Stop whenever you are bored by pressing ``Ctrl+C`` and resume the task where +you left it at next run. + +Use ``Ctrl+D`` to exit brutally and discard all changes