Skip to content

Commit

Permalink
great renaming: von_agent becomes von_anchor
Browse files Browse the repository at this point in the history
  • Loading branch information
sklump committed Jul 12, 2018
1 parent 0b1c17c commit 5917a3d
Show file tree
Hide file tree
Showing 32 changed files with 788 additions and 757 deletions.
37 changes: 18 additions & 19 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,31 +1,30 @@
von_agent
=========
As part of the technology demonstrator project using Hyperledger indy to explore, among other VON network facilities, the use of the distributed ledger with PSPC Supplier Registration Information (SRI), the design specifies agents to interact with the sovrin distributed ledger as realized through indy-sdk.
von_anchor
==========
As part of the technology demonstrator project using Hyperledger indy to explore, among other VON network facilities, the use of the distributed ledger with PSPC Supplier Registration Information (SRI), the design specifies anchors to interact with the sovrin distributed ledger as realized through indy-sdk.

The demonstration defines the following agents:
The demonstration defines the following anchors:

- the Trust Anchor agent as:
- the Trustee anchor as:

- the agent registrar on the distributed ledger
- a schema originator (purely academically, for the demonstration)
- the BC Registrar agent as:
- the anchor writing further anchors onto the distributed ledger
- the BC Registrar anchor as:

- a schema originator for its own claims
- an issuer of claims
- the BC Org Book agent as, for claims that the BC Registrar issues:
- a schema originator for its own credentials
- an issuer of credentials
- the BC Org Book anchor as, for credentials that the BC Registrar issues:

- a W3C claims holder
- a W3C credentials holder
- an indy-sdk prover
- the SRI agent as:
- the SRI anchor as:

- a schema originator for its own claims
- an issuer of claims
- a verifier of claims, whether itself or the BC Registrar agent issued them
- the PSPC Org Book as, for claims that the SRI agent issues:
- a schema originator for its own credentials
- an issuer of credentials
- a verifier of credentials, whether itself or the BC Registrar anchor issued them
- the PSPC Org Book as, for credentials that the SRI anchor issues:

- a W3C claims holder
- a W3C credentials holder
- an indy-sdk prover.

Documentation
=============
The design document is available from the ``von_base`` repository (<https://github.com/PSPC-SPAC-buyandsell/von_base.git>) at ``doc/agent-design.doc``. The design document includes instructions for installation, configuration, and operation of ``von_agent``.
The design document is available from the ``von_base`` repository (<https://github.com/PSPC-SPAC-buyandsell/von_base.git>) at ``doc/anchor-design.doc``. The design document includes instructions for installation, configuration, and operation of ``von_anchor``.
4 changes: 2 additions & 2 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = VONAgent
SPHINXPROJ = VONAnchor
SOURCEDIR = source
BUILDDIR = build

Expand All @@ -17,4 +17,4 @@ help:
# Catch-all target: route all unknown targets to Sphinx using the new
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
%: Makefile
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14 changes: 7 additions & 7 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# VON Agent documentation build configuration file, created by
# VON Anchor documentation build configuration file, created by
# sphinx-quickstart on Wed May 16 00:36:06 2018.
#
# This file is execfile()d with the current directory set to its
Expand Down Expand Up @@ -55,7 +55,7 @@
master_doc = 'index'

# General information about the project.
project = 'VON Agent'
project = 'VON Anchor'
copyright = '2018, Stephen Klump'
author = 'Stephen Klump'

Expand Down Expand Up @@ -123,7 +123,7 @@
# -- Options for HTMLHelp output ------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'VONAgentdoc'
htmlhelp_basename = 'VONAnchordoc'


# -- Options for LaTeX output ---------------------------------------------
Expand All @@ -150,7 +150,7 @@
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'VONAgent.tex', 'VON Agent Documentation',
(master_doc, 'VON_Anchor.tex', 'VON Anchor Documentation',
'Stephen Klump', 'manual'),
]

Expand All @@ -160,7 +160,7 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'vonagent', 'VON Agent Documentation',
(master_doc, 'von_anchor', 'VON Anchor Documentation',
[author], 1)
]

Expand All @@ -171,8 +171,8 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'VONAgent', 'VON Agent Documentation',
author, 'VONAgent', 'One line description of project.',
(master_doc, 'VON_Anchor', 'VON Anchor Documentation',
author, 'VON_Anchor', 'One line description of project.',
'Miscellaneous'),
]

Expand Down
6 changes: 3 additions & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
.. VON Agent documentation master file, created by
.. VON Anchor documentation master file, created by
sphinx-quickstart on Wed May 16 00:36:06 2018.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to VON Agent's documentation!
=====================================
Welcome to VON Anchor's documentation!
======================================

.. toctree::
:maxdepth: 2
Expand Down
6 changes: 3 additions & 3 deletions docs/source/modules.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
von_agent
=========
von_anchor
==========

.. toctree::
:maxdepth: 4

von_agent
von_anchor
102 changes: 0 additions & 102 deletions docs/source/von_agent.rst

This file was deleted.

134 changes: 134 additions & 0 deletions docs/source/von_anchor.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
von\_anchor package
==================

Submodules
----------

von\_anchor.anchor.base module
------------------------------

.. automodule:: von_anchor.anchor.base
:members:
:undoc-members:
:show-inheritance:

von\_anchor.anchor.demo module
------------------------------

.. automodule:: von_anchor.anchor.demo
:members:
:undoc-members:
:show-inheritance:

von\_anchor.anchor.holder\_prover module
---------------------------------------

.. automodule:: von_anchor.anchor.holder_prover
:members:
:undoc-members:
:show-inheritance:

von\_anchor.anchor.issuer module
--------------------------------

.. automodule:: von_anchor.anchor.issuer
:members:
:undoc-members:
:show-inheritance:

von\_anchor.anchor.origin module
--------------------------------

.. automodule:: von_anchor.anchor.origin
:members:
:undoc-members:
:show-inheritance:

von\_anchor.anchor.smith module
------------------------------

.. automodule:: von_anchor.anchor.smith
:members:
:undoc-members:
:show-inheritance:

von\_anchor.anchor.verifier module
----------------------------------

.. automodule:: von_anchor.verifier.demo
:members:
:undoc-members:
:show-inheritance:

von\_anchor.cache module
------------------------

.. automodule:: von_anchor.cache
:members:
:undoc-members:
:show-inheritance:

von\_anchor.codec module
------------------------

.. automodule:: von_anchor.codec
:members:
:undoc-members:
:show-inheritance:

von\_anchor.error module
------------------------

.. automodule:: von_anchor.error
:members:
:undoc-members:
:show-inheritance:

von\_anchor.nodepool module
---------------------------

.. automodule:: von_anchor.nodepool
:members:
:undoc-members:
:show-inheritance:

von\_anchor.tails module
------------------------

.. automodule:: von_anchor.tails
:members:
:undoc-members:
:show-inheritance:

von\_anchor.util module
-----------------------

.. automodule:: von_anchor.util
:members:
:undoc-members:
:show-inheritance:

von\_anchor.validate\_config module
-----------------------------------

.. automodule:: von_anchor.validate_config
:members:
:undoc-members:
:show-inheritance:

von\_anchor.wallet module
-------------------------

.. automodule:: von_anchor.wallet
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

.. automodule:: von_anchor
:members:
:undoc-members:
:show-inheritance:
2 changes: 1 addition & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
base58>=0.2.5
python3-indy==1.5.0-dev-617
python3-indy==1.5.0-dev-620
jsonschema>=2.6.0
Loading

0 comments on commit 5917a3d

Please sign in to comment.