python-pskc branch master updated. 0.5-23-g4c5e046

[Commits of the python-pskc project <python-pskc-commits [at] lists.arthurdejong.org>]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "python-pskc".

The branch, master has been updated
       via  4c5e04612937c95409056818c13f60e1221a773a (commit)
      from  25cb2fc2e55147ad6b7a4a8a0754d972448a13a9 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
https://arthurdejong.org/git/python-pskc/commit/?id=4c5e04612937c95409056818c13f60e1221a773a

commit 4c5e04612937c95409056818c13f60e1221a773a
Author: Arthur de Jong <arthur@arthurdejong.org>
Date:   Wed Oct 11 22:37:10 2017 +0200

    Add a manual page for pskc2csv

diff --git a/docs/conf.py b/docs/conf.py
index 2487640..41c53f7 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -173,7 +173,7 @@ html_show_sourcelink = False
 #html_file_suffix = None
 
 # Suffix for generated links to HTML files.
-#html_link_suffix = ''
+html_link_suffix = ''
 
 # Output file base name for HTML help builder.
 htmlhelp_basename = 'python-pskcdoc'
@@ -184,11 +184,11 @@ htmlhelp_basename = 'python-pskcdoc'
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('index', 'python-pskc', u'python-pskc Documentation',
+    ('pskc2csv', 'pskc2csv', u'Convert a PSKC file to CSV',
      [u'Arthur de Jong'], 1)
 ]
 
 # If true, show URL addresses after external links.
-#man_show_urls = False
+man_show_urls = True
 
 intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
diff --git a/docs/pskc2csv.rst b/docs/pskc2csv.rst
new file mode 100644
index 0000000..4602121
--- /dev/null
+++ b/docs/pskc2csv.rst
@@ -0,0 +1,65 @@
+:orphan:
+
+pskc2csv
+========
+
+Synopsis
+--------
+
+**pskc2csv** [*options*] <*FILE*>
+
+Description
+-----------
+
+:program:`pskc2csv` reads a PSKC file, optionally decrypts any encrypted key
+material and outputs a CSV file with information from the PSKC file.
+
+Options
+-------
+
+.. program:: pskc2csv
+
+.. option:: -h, --help
+
+   Display usage summary.
+
+.. option:: -V, --version
+
+   Display version information.
+
+.. option:: -o FILE, --output FILE
+
+   By default :program:`pskc2csv` writes a CSV file to stdout. This option
+   can be used to save the CSV to a file instead.
+
+.. option:: -c COL:LABEL,COL,.., --columns COL:LABEL,COL,..
+
+   Specify the columns that should be written to the CSV file. Any
+   property of :class:`~pskc.key.Key` instances can be used as well
+   as :class:`~pskc.policy.Policy` properties via ``policy``.
+
+   For example: ``serial``, ``secret``, ``counter``, ``time_offset``,
+   ``time_interval``, ``interval``, ``time_drift``, ``issuer``,
+   ``manufacturer``, ``response_length``, ``policy.pin_min_length``.
+
+   By default ``serial,secret,algorithm,response_length,time_interval`` is
+   used.
+
+   The column can be followed by an optional label to use in the CSV file in
+   place of the column specification.
+
+.. option:: -p PASS/FILE, --password PASS/FILE, --passwd PASS/FILE
+
+   The password to use for decryption. If the argument refers to a file the
+   password is read from the file instead.
+
+.. option:: -s KEY/FILE, --secret KEY/FILE
+
+   A hex encoded encryption key or a file containing the binary (raw data,
+   not encoded) key.
+
+.. option:: -e ENCODING, --secret-encoding ENCODING
+
+   Specify the encoding to use for writing key material to the CSV file. By
+   default HEX encoding is used. Valid encodings are: ``base32``, ``base64``
+   or ``hex``.
diff --git a/setup.cfg b/setup.cfg
index 0c042e0..9f47e8f 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -16,7 +16,8 @@ cover-html-dir=coverage
 cover-min-percentage=100
 
 [build_sphinx]
-all_files  = 1
+all_files = 1
+builder = html,man
 
 [flake8]
 ignore = D101,D102,D105,D107,D202,D205,D209,D400,N806

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

Summary of changes:
 docs/conf.py      |  6 ++---
 docs/pskc2csv.rst | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++
 setup.cfg         |  3 ++-
 3 files changed, 70 insertions(+), 4 deletions(-)
 create mode 100644 docs/pskc2csv.rst


hooks/post-receive
-- 
python-pskc
-- 
To unsubscribe send an email to
python-pskc-commits-unsubscribe@lists.arthurdejong.org or see
https://lists.arthurdejong.org/python-pskc-commits/