decred · buck54321 · Jan 24, 2020 · Jan 16, 2020 · Jan 16, 2020 · Jan 16, 2020
diff --git a/.github/workflows/python.yml b/.github/workflows/python.yml
@@ -14,24 +14,33 @@ jobs:
       uses: actions/setup-python@v1
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Install dependencies
+    - name: Install pip
       run: |
         python -m pip install --upgrade pip
-        pip install -r requirements.txt
-    - name: Lint with black
+    - name: Lint all code with black
       run: |
         pip install black
         # stop the build if the code was not reformatted by black
         black . --check
-    - name: Lint with flake8
+    - name: Lint all code with flake8
       run: |
         pip install flake8
-        # stop the build if there are Python syntax errors or undefined names
+        # stop the build if there are syntax errors or undefined names
         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero  --ignore=E203,E221,E261,E731,W503 --max-complexity=10 --max-line-length=127 --statistics
-    - name: Test with pytest
+        # exit-zero treats all errors as warnings
+        flake8 . --count --exit-zero  --ignore=E203,E221,E261,E731,W503 --max-complexity=10 --max-line-length=88 --statistics
+    - name: Install the poetry tool
       run: |
-        pip install pytest
-        cd ..
-        python -m pytest ./tinydecred/tests/unit/
+        pip install poetry
+    - name: Install the decred package and its dependencies (including pytest)
+      working-directory: ./decred/
+      run: |
+        poetry install
+    - name: Test the decred package with pytest
+      working-directory: ./decred/
+      run: |
+        poetry run pytest ./tests/unit/
+    - name: Build the decred package
+      working-directory: ./decred/
+      run: |
+        poetry build
diff --git a/.gitignore b/.gitignore
@@ -1,5 +1,11 @@
+examples/testnet
+decred/dist
+tinywallet/dist
+decred/poetry.lock
 __pycache__/
+.pytest_cache
+.coverage
+.venv
+*.egg-info
 *.sublime-project
 *.sublime-workspace
-examples/testnet
-.coverage
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,33 @@
+# Contribution guidelines
+
+Thank you for contributing to this project! The developers are part of the
+[Decred community](https://decred.org/community/) and coordinate in a
+[chat](https://chat.decred.org/#/room/#tinydecred:decred.org) on the
+[Matrix](https://matrix.org/) platform, you'll need a (free) account to access
+it.
+
+## Bugs and new features
+
+If you found a bug, before creating an issue please search among the
+[open ones](https://github.com/decred/tinydecred/issues). Please add as many
+useful details as you can.
+
+If you'd like to request a new feature, either create an issue (again, after
+searching first) or, preferably, discuss your request with the developers as
+mentioned above.
+
+## Development
+
+This project is managed via the [Poetry](https://python-poetry.org/) tool.
+You'll reformat your changes with the [Black](https://black.readthedocs.io/)
+tool and run tests using [pytest](https://www.pytest.org/).
+
+Before each pull request is merged, a Github workflow action is run to make
+sure that the changes meet some minimum requirements. The action definition
+[file](./.github/workflows/python.yml) is a useful summary of the commands
+you'll run while developing.
+
+## More information
+
+Please find more information in the dcrd
+[contribution guidelines](https://github.com/decred/dcrd/blob/master/docs/code_contribution_guidelines.md).
diff --git a/README.md b/README.md
@@ -1,85 +1,23 @@
-tinydecred
-==========
+# tinydecred
 
 [![Build Status](https://github.com/decred/tinydecred/workflows/Build%20and%20Test/badge.svg)](https://github.com/decred/tinydecred/actions)
-[![ISC License](https://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
+[![ISC License](https://img.shields.io/badge/license-ISC-blue.svg)](https://copyfree.org/)
 
-## Overview
+TinyDecred is a Python 3 toolkit that can be used to integrate
+[Decred](https://decred.org/) into Python projects.
 
-A Python 3 Decred toolkit. The modules in TinyDecred can be used to integrate
-Decred into Python projects. Everything needed to create wallets to send and
-receive DCR.
+The [`decred`](./decred) package contains everything needed to create wallets
+to send and receive DCR.
 
-## Features
+The [`tinywallet`](./tinywallet) package contains such a light wallet based on
+PyQt5.
 
-1. Pure-Python secp256k1 elliptic curve.
-
-1. Serializable and de-serializable python versions of important types
-from the dcrd/wire package: `MsgTx`, `BlockHeader`, `OutPoint`, etc.
-
-1. BIP-0044 keys. Account creation and management. PGP mnemonic seeds.
-
-1. Network parameters for mainnet, testnet3, and simnet.
-
-1. Clients for the dcrdata block explorer API (websockets, pubsub, HTTP).
-
-1. Experimental PyQt5 light wallet.
-
-## Installation
-
-Install by cloning the git repo.
-The parent directory of *tinydecred* will need to be in `sys.path`.
-You can add it by setting the `PYTHONPATH` environment variable.
-Alternatively, you can put a symlink to the *tinydecred* directory in your
-Python installation's *lib/site-packages/* directory or other `sys.path`
-directory.
-
-All dependencies are available through PyPi.
-
-```
-pip3 install -r requirements.txt
-```
-
-though depending on your setup, you may need `sudo`, and `pip3` might be `pip`.
-
-You're probably okay to use newer versions of PyQt5, but `5.9.2` has been
-remarkably stable.
-
-## Examples
-
-In the examples directory, there are scripts for creating and using wallets,
-and for using dcrdata and matplotlib to plot Decred network data.
-
-## TinyDecred GUI Wallet
-
-TinyDecred is the name of the package as well as the experimental light wallet
-GUI application.
-**The light wallet is experimental, and should not be used on mainnet.**
-
-To start the wallet, navigate to the `tinydecred` package directory, and run
-
-```
-python app.py --testnet
-```
-
-The wallet runs as a system-tray application, of which the major difference is
-that "closing" the wallet actually just removes the entry from the taskbar and
-minimizes the window "to the system tray".
-The wallet can then be "opened" again through the icon in the system tray.
-
-![alt text][screenshot]
-
-TinyDecred is pretty small.
-Like Decred, it's meant to be an omnipresent yet largely invisible and
-unobtrusive part of your digital environment.
-The small dialog size keeps user interactions focused.
-Bells and whistles are minimized in favor of simplicity whenever possible.
-Blockchain mechanics are invisible.
-The goal is to make using Decred easier than pulling change out of your pocket.
+Each package may be installed from the [Python Package Index](https://pypi.org/)
+using the [`pip`](https://pip.pypa.io/) command as usual.
 
 ## Roadmap
 
-In no particular order
+In no particular order:
 
 - Staking
 - Schnorr signatures and Edwards curve
@@ -88,4 +26,6 @@ In no particular order
 - Decred DEX integration
 - Lightning network
 
-[screenshot]: https://user-images.githubusercontent.com/6109680/62095772-08b4ce80-b247-11e9-81ae-66931ebb07be.png
+## Contributing
+
+See the [contribution guidelines](./CONTRIBUTING.md).
diff --git a/.coveragerc → decred/.coveragerc b/.coveragerc → decred/.coveragerc
diff --git a/pydecred/README.md → decred/README.md b/pydecred/README.md → decred/README.md
@@ -1,25 +1,43 @@
-## PyDecred
+# decred
 
-PyDecred is a set of modules that enable Decred-compatible blockchain
-applications. The **dcrdata** module contains a dcrdata client and a TinyDecred
-*Blockchain API* implementation.
+The `decred` package contains everything needed to create wallets to send and
+receive [DCR](https://decred.org/).
 
-The **wire** module mirrors it's dcrd golang counterpart, providing serializable
+## Features
+
+1. Pure-Python secp256k1 elliptic curve.
+
+1. Serializable and de-serializable python versions of important types
+from the `dcrd/wire` package: `MsgTx`, `BlockHeader`, `OutPoint`, etc.
+
+1. BIP-0044 keys. Account creation and management. PGP mnemonic seeds.
+
+1. Network parameters for mainnet, testnet3, and simnet.
+
+1. Clients for the dcrdata block explorer API (websockets, pubsub, HTTP).
+
+## dcr
+
+dcr is a package that enables Decred-compatible blockchain applications. The
+`dcrdata` module contains a dcrdata client and a TinyDecred *Blockchain API*
+implementation.
+
+The `wire` module mirrors its dcrd Go counterpart, providing serializable
 transactions and blocks.
 
-Network parameters are implemented as modules **mainnet**, **testnet**, and
-**simnet**.
+Network parameters are implemented as modules `mainnet`, `testnet`, and
+`simnet`.
 
-## DcrdataClient
+### DcrdataClient
 
 DcrdataClient is a dcrdata API client written in Python 3.
 
 The constructor takes a single argument, which is the path to a dcrdata server,
-including protocol, e.g. `https://explorer.dcrdata.org`. The available endpoints
-are gathered from the server when the client is created.
+including protocol, e.g. `https://explorer.dcrdata.org/`. The available
+endpoints are gathered from the server when the client is created.
 
 ```
-from tinydecred.pydecred.dcrdata import DcrdataClient
+from decred.dcr.dcrdata import DcrdataClient
 import json
 
 client = DcrdataClient("https://explorer.dcrdata.org")
@@ -33,13 +51,17 @@ The acquired list does not include some endpoints, particularly the Insight API
 endpoints.
 
 You can print an endpoint guide to the console with  `client.endpointGuide()`,
-
 or a Python list of URLs is returned from `client.endpointList()`.
 
 Depending on the version of dcrdata they are running, different servers might
 have different sets of endpoints.
 
-### Examples
+## Examples
+
+In the [`examples`](./examples) directory there are scripts for creating and
+using wallets, and for using dcrdata and matplotlib to plot Decred network data.
+
+Here are some more examples:
 
 ```
 def dumpResponse(obj):

diff --git a/__init__.py → decred/decred/__init__.py b/__init__.py → decred/decred/__init__.py
diff --git a/config.py → decred/decred/config.py b/config.py → decred/decred/config.py
@@ -11,8 +11,9 @@
 
 from appdirs import AppDirs
 
-from tinydecred.pydecred import nets
-from tinydecred.util import helpers
+from decred.dcr import nets
+from decred.util import helpers
+
 
 # Set the data directory in a OS-appropriate location.
 _ad = AppDirs("TinyDecred", False)

diff --git a/crypto/__init__.py → decred/decred/crypto/__init__.py b/crypto/__init__.py → decred/decred/crypto/__init__.py
diff --git a/crypto/crypto.py → decred/decred/crypto/crypto.py b/crypto/crypto.py → decred/decred/crypto/crypto.py
@@ -13,10 +13,10 @@
 from blake256.blake256 import blake_hash
 import nacl.secret
 
-from tinydecred.util.encode import ByteArray
-from tinydecred.crypto import rando
-from tinydecred.crypto.secp256k1.curve import curve as Curve, PublicKey, PrivateKey
-from tinydecred.util import encode
+from decred.util import encode
+from decred.util.encode import ByteArray
+from . import rando
+from .secp256k1.curve import curve as Curve, PublicKey, PrivateKey
 
 
 KEY_SIZE = 32

diff --git a/crypto/mnemonic.py → decred/decred/crypto/mnemonic.py b/crypto/mnemonic.py → decred/decred/crypto/mnemonic.py
@@ -6,8 +6,9 @@
 PGP-based mnemonic seed generation.
 """
 
-from tinydecred.util.encode import ByteArray
-from tinydecred.crypto.crypto import sha256ChecksumByte
+from decred.util.encode import ByteArray
+from .crypto import sha256ChecksumByte
+
 
 alternatingWords = """aardvark
 adroitness

diff --git a/crypto/opcode.py → decred/decred/crypto/opcode.py b/crypto/opcode.py → decred/decred/crypto/opcode.py
diff --git a/crypto/rando.py → decred/decred/crypto/rando.py b/crypto/rando.py → decred/decred/crypto/rando.py
diff --git a/crypto/secp256k1/__init__.py → decred/decred/crypto/secp256k1/__init__.py b/crypto/secp256k1/__init__.py → decred/decred/crypto/secp256k1/__init__.py
diff --git a/crypto/secp256k1/bytepoints.py → decred/decred/crypto/secp256k1/bytepoints.py b/crypto/secp256k1/bytepoints.py → decred/decred/crypto/secp256k1/bytepoints.py
diff --git a/crypto/secp256k1/curve.py → decred/decred/crypto/secp256k1/curve.py b/crypto/secp256k1/curve.py → decred/decred/crypto/secp256k1/curve.py
@@ -8,9 +8,10 @@
     dcrd golang version.
 """
 
-from tinydecred.util.encode import ByteArray
-from tinydecred.crypto.rando import generateSeed
-from tinydecred.crypto.secp256k1.field import FieldVal, BytePoints
+from decred.util.encode import ByteArray
+from decred.crypto.rando import generateSeed
+from .field import BytePoints, FieldVal
+
 
 COORDINATE_LEN = 32
 PUBKEY_COMPRESSED_LEN = COORDINATE_LEN + 1

diff --git a/crypto/secp256k1/field.py → decred/decred/crypto/secp256k1/field.py b/crypto/secp256k1/field.py → decred/decred/crypto/secp256k1/field.py
@@ -7,8 +7,9 @@
 from base64 import b64decode
 from zlib import decompress as zdecompress
 
-from tinydecred.util.encode import ByteArray
-from tinydecred.crypto.secp256k1.bytepoints import secp256k1BytePoints
+from decred.util.encode import ByteArray
+from .bytepoints import secp256k1BytePoints
+
 
 # Constants used to make the code more readable.
 twoBitsMask = 0x03

diff --git a/pydecred/__init__.py → decred/decred/dcr/__init__.py b/pydecred/__init__.py → decred/decred/dcr/__init__.py
diff --git a/pydecred/account.py → decred/decred/dcr/account.py b/pydecred/account.py → decred/decred/dcr/account.py
@@ -3,11 +3,11 @@
 See LICENSE for details
 """
 
-from tinydecred.util import helpers, encode
-from tinydecred.crypto import opcode, crypto
-from tinydecred.pydecred import txscript
-from tinydecred.pydecred.vsp import VotingServiceProvider
-from tinydecred.pydecred import nets
+from decred.crypto import opcode, crypto
+from decred.util import encode, helpers
+from . import nets, txscript
+from .vsp import VotingServiceProvider
+
 
 log = helpers.getLogger("DCRACCT")
 

diff --git a/pydecred/calc.py → decred/decred/dcr/calc.py b/pydecred/calc.py → decred/decred/dcr/calc.py
@@ -4,10 +4,13 @@
 
 Some network math.
 """
-import math
+
 import bisect
-from tinydecred.util import helpers
-from tinydecred.pydecred import constants as C, mainnet
+import math
+
+from decred.util import helpers
+from . import constants as C, mainnet
+
 
 NETWORK = mainnet
 MODEL_DEVICE = {

diff --git a/pydecred/constants.py → decred/decred/dcr/constants.py b/pydecred/constants.py → decred/decred/dcr/constants.py
@@ -4,8 +4,10 @@
 
 Just some constants.
 """
+
 import os
 
+
 PYDECRED_PACKAGEDIR = os.path.dirname(os.path.realpath(__file__))
 FAVICON = os.path.join(PYDECRED_PACKAGEDIR, "favicon-32x32.png")
 LOGO = os.path.join(PYDECRED_PACKAGEDIR, "logo.svg")