From 3141c424b02ff658275011f1dd2ebf85782eac08 Mon Sep 17 00:00:00 2001
From: Fabian Schuh <Fabian@chainsquad.com>
Date: Wed, 12 Apr 2017 16:48:03 +0200
Subject: [PATCH] [docs] add more documentation as requested #2
---
docs/configuration.rst | 34 ++++++++++++++++++++++++++++++++++
docs/contribute.rst | 7 +++++++
docs/index.rst | 1 +
docs/storage.rst | 11 +++++++----
docs/support.rst | 10 ++++++++++
docs/wallet.rst | 16 ++++++++++++++++
6 files changed, 75 insertions(+), 4 deletions(-)
create mode 100644 docs/configuration.rst
create mode 100644 docs/support.rst
diff --git a/docs/configuration.rst b/docs/configuration.rst
new file mode 100644
index 00000000..13db5458
--- /dev/null
+++ b/docs/configuration.rst
@@ -0,0 +1,34 @@
+*************
+Configuration
+*************
+
+The pybitshares library comes with its own local configuration database
+that stores information like
+
+* API node URL
+* default account name
+* the encrypted master password
+
+and potentially more.
+
+You can access those variables like a regular dictionary by using
+
+.. code-block:: python
+
+ from bitshares import BitShares
+ bitshares = BitShares()
+ print(bitshares.config.items())
+
+Keys can be added and changed like they are for regular dictionaries.
+
+If you don't want to load the :class:`bitshares.BitShares` class, you
+can load the configuration directly by using:
+
+.. code-block:: python
+
+ from bitshares.storage import configStorage as config
+
+API
+---
+.. autoclass:: bitshares.storage.Configuration
+ :members:
diff --git a/docs/contribute.rst b/docs/contribute.rst
index a296fd89..0eaa10b4 100644
--- a/docs/contribute.rst
+++ b/docs/contribute.rst
@@ -3,6 +3,13 @@ Contributing to python-bitshares
We welcome your contributions to our project.
+Repository
+----------
+
+The *main* repository of python-bitshares is currently located at:
+
+ https://github.com/xeroc/python-bitshares
+
Flow
----
diff --git a/docs/index.rst b/docs/index.rst
index 2a3e230d..763fd59d 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -103,6 +103,7 @@ General
quickstart
tutorials
contribute
+ support
Python-BitShares Libraries
--------------------------
diff --git a/docs/storage.rst b/docs/storage.rst
index dad51393..3fc9abc6 100644
--- a/docs/storage.rst
+++ b/docs/storage.rst
@@ -1,5 +1,11 @@
+*******
Storage
-~~~~~~~~~
+*******
+
+These classes are very low level and are not well documented.
+
+API
+---
.. autoclass:: bitshares.storage.DataDir
:members:
@@ -7,8 +13,5 @@ Storage
.. autoclass:: bitshares.storage.Key
:members:
-.. autoclass:: bitshares.storage.Configuration
- :members:
-
.. autoclass:: bitshares.storage.MasterPassword
:members:
diff --git a/docs/support.rst b/docs/support.rst
new file mode 100644
index 00000000..f63b4fb8
--- /dev/null
+++ b/docs/support.rst
@@ -0,0 +1,10 @@
+*********************
+Support and Questions
+*********************
+
+We have currently not setup a distinct channel for development around
+pybitshares. However, many of the contributors are frequently reading
+through these channels:
+
+* https://bitsharestalk.org
+* https://t.me/BitSharesDEX
diff --git a/docs/wallet.rst b/docs/wallet.rst
index 467b0697..e46d3be4 100644
--- a/docs/wallet.rst
+++ b/docs/wallet.rst
@@ -25,6 +25,22 @@ The wallet can be unlocked for signing using
bitshares = BitShares()
bitshares.wallet.unlock("supersecret-passphrase")
+Adding a Private Key
+--------------------
+
+A private key can be added by using the
+:func:`bitshares.wallet.Wallet.addPrivateKey` method that is available
+**after** unlocking the wallet with the correct passphrase:
+
+.. code-block:: python
+ from bitshares import BitShares
+ bitshares = BitShares()
+ bitshares.wallet.unlock("supersecret-passphrase")
+ bitshares.wallet.addPrivateKey("5xxxxxxxxxxxxxxxxxxxx")
+
+.. note:: The private key has to be either in hexadecimal or in wallet
+ import format (wif) (starting with a ``5``).
+
API
---
--
GitLab