flip/web3.py
1
0
Fork 0
mirror of https://github.com/FlipsideCrypto/web3.py.git synced 2026-02-06 02:46:45 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

setup documentation

Browse Source
This commit is contained in:
Piper Merriam 2016-09-06 12:49:40 -06:00
parent e8d20a6b09
commit d0da4ac4e8
9 changed files with 876 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.gitignore vendored
View File

@ -40,6 +40,10 @@ output/*/index.html
# Sphinx
docs/_build
docs/modules.rst
docs/web3.rst
docs/web3.providers.rst
docs/web3.utils.rst
# Blockchain
chains

8
Makefile
View File

@ -30,6 +30,14 @@ test:
test-all:
tox
docs:
rm -f docs/web3.rst
rm -f docs/modules.rst
sphinx-apidoc -o docs/ web3
$(MAKE) -C docs clean
$(MAKE) -C docs html
open docs/_build/html/index.html
release: clean
python setup.py sdist bdist_wheel upload

177
docs/Makefile Normal file
View File

@ -0,0 +1,177 @@
# 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 gettext
help:
@echo "Please use \`make <target>' where <target> 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)"
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/web3.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/web3.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/web3"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/web3"
@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."
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."

257
docs/conf.py Normal file
View File

@ -0,0 +1,257 @@
# -*- coding: utf-8 -*-
#
# Web3.py documentation build configuration file, created by
# sphinx-quickstart on Thu Oct 16 20:43:24 2014.
#
# 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.
# 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 = ['sphinx.ext.autodoc']
# 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'Web3.py'
copyright = u'2016, Piper Merriam'
__version__ = '2.4.0'
# 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 = '.'.join(__version__.split('.')[:2])
# The full version, including alpha/beta/rc tags.
release = __version__
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#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 = 'better'
# 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 = {}
# Add any paths that contain custom themes here, relative to this directory.
from better import better_theme_path
html_theme_path = [better_theme_path]
# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
#html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
#html_short_title = None
# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None
# 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 = {}
# 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 <link> 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
# Output file base name for HTML help builder.
htmlhelp_basename = 'Populusdoc'
# -- 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': '',
}
# 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', 'Populus.tex', u'Populus Documentation',
u'Piper Merriam', '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', 'web3', u'Web3.py Documentation',
[u'Piper Merriam'], 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', 'Web3.py', u'Web3.py Documentation',
u'Piper Merriam', 'Web3.py', 'Backend agnostic Ethereum client interactions.',
'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

31
docs/index.rst Normal file
View File

@ -0,0 +1,31 @@
Populus
=======
Populus is a smart contract development framework for the Ethereum blockchain.
Contents
--------
.. toctree::
:maxdepth: 1
quickstart
overview
tutorial
compile
testing
deploy
migrations
config
chain
release
modules
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

80
docs/overview.rst Normal file
View File

@ -0,0 +1,80 @@
Overview
========
.. contents:: :local:
Introduction
------------
The primary interface to populus is the command line command ``$ populus``.
Command Line Options
--------------------
.. code-block:: shell
$ populus
Usage: populus [OPTIONS] COMMAND [ARGS]...
Populus
Options:
-c, --config FILENAME Specify a populus configuration file to be used. No
other configuration files will be loaded
-h, --help Show this message and exit.
Commands:
chain Manage and run ethereum blockchains.
compile Compile project contracts, storing their...
config Print the current project configuration
config:set Sets key/value pairs in the populus.ini...
config:unset Deletes the provided keys from the...
deploy Deploys the specified contracts to a chain.
init Generate project layout with an example...
makemigration Generate an empty migration.
migrate Run project migrations
Project Layout
--------------
By default Populus expects a project to be layed out as follows.
.. code-block:: shell
   └── project root
   ├── build (automatically created during compilation)
   │   └── contracts.json
   ├── contracts
   | ├── MyContract.sol
| ├── ....
   └── tests
   ├── test_my_contract.py
   ├── test_some_other_tests.py
├── ....
      └── ....
.. _init:
Initialize
~~~~~~~~~~
.. code-block:: shell
$ populus init --help
Usage: populus init [OPTIONS]
Generate project layout with an example contract.
Options:
-h, --help Show this message and exit.
Running ``$ populus init`` will initialize the current directory with the
default project layout that populus uses.
* ``./contracts/``
* ``./contracts/Greeter.sol``
* ``./tests/test_greeter.py``

144
docs/project.rst Normal file
View File

@ -0,0 +1,144 @@
Project
-------
.. contents:: :local:
Introduction
^^^^^^^^^^^^
The ``populus.project.Project`` API is the common entry point to all aspects of
your populus project.
Basic Usage
^^^^^^^^^^^
``Project(config_file_paths=None)``
When instantaited with no arguments, the project will load any ``populus.ini``
file found in the current working directory and the current user's ``$HOME``
directory.
If there are specific configuration files that you would like loaded then you
can do so by passing them in as an array to the constructor.
.. code-block::
from populus.project import Project
# loads local `populus.ini` and `$HOME/populus.ini` if present.
project = Project()
# loads only the specified paths.
other_project = Project(['/path/to/other/populus.ini'])
other_project = Project([
'/path/to/other/populus.ini',
'/another/path/config.ini',
])
Configuration files are loaded in reverse order meaning that configuration
values set in the first files will supercede files later in the list.
Loading, Reloading, and Writing
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
* ``Project.primary_config_file_path``
The path that configuration will be written to by default when
``Project.write_config()`` is called. This defaults to a file named
``populus.ini`` in ``Project.project_dir``.
* ``Project.load_config(config_file_paths=None)``
Loads the configuration files denoted by ``config_file_paths``. If no
paths are given, defaults to loading the local ``populus.ini`` and
``$HOME/populus.ini`` files. This operation is destructive and will
override any configuration changes that have been made.
* ``Project.write_config(destination_path=None)``
Writes the current project configuration to the given ``destination_path``.
If no desitnation path is given, defaults to
``Project.primary_config_file_path``.
* ``Project.reload_config()``
Reloads the configuration files. This operation is destructive and will
override any configuration changes that have been made.
Filesystem Path Properties and Methods
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Populus exposes properties and methods to access the the various filesystem
dictories and paths that populus uses.
* ``Project.project_dir``:
The path that populus will treat as the root of your
project. This defaults to the current working directory. It can be
overridden in your ``populus.ini`` under the ``[populus]`` section with the
option ``project_dir``.
* ``Project.contracts_dir``:
The path under which populus will search for contracts to compile.
* ``Project.build_dir``:
The path that populus will place it's build artifacts from compilation.
* ``Project.compiled_contracts_file_path``:
The path that the JSON build artifact will be written to.
* ``Project.compile_project_contracts``:
The parsed JSON output loaded from the
``Project.compiled_contracts_file_path``.
* ``Project.get_chain(chain_name, *chain_args, *chain_kwargs)``:
Returns the ``populus.chain.Chain`` instance associated with the geven
``chain_name``. The ``chain_args`` and ``chain_kwargs`` are passed through
to the constructor of the underlying ``populus.chain.Chain`` object.
* ``Project.blockchains_dir``
The path that the files for local blockchains will be placed.
* ``Project.get_blockchain_data_dir(chain_name)``
Return the data directory for the blockchain with the given name.
* ``Project.get_blockchain_chaindata_dir(chain_name)``
Returns the chaindata directory for the blockchain with the given name.
* ``Project.get_blockchain_ipc_path(chain_name)``
Returns the path to the ``geth.ipc`` socket for the blockchain with the given name.
* ``Project.migrations_dir``
The path that the project migration files are located.
* ``Project.migration_files``
A list of all of the file paths to the project migrations.
* ``Project.migrations``
A list of all of the project migration classes loaded from the
``Project.migration_files``. The classes are returned ordered according to
their declaired dependencies.

157
docs/quickstart.rst Normal file
View File

@ -0,0 +1,157 @@
Quickstart
==========
.. contents:: :local:
System Dependencies
-------------------
Populus depends on the following system dependencies.
* `Solidity`_ : For contract compilation
* `Go Ethereum`_: For running test chains and contract deployment.
In addition, populus needs some system dependencies to be able to install the
`PyEthereum`_ library.
Debian, Ubuntu, Mint
~~~~~~~~~~~~~~~~~~~~
.. code-block:: shell
sudo apt-get install libssl-dev
Fedora, CentOS, RedHat
~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: shell
sudo yum install openssl-devel
OSX
~~~
.. code-block:: shell
brew install pkg-config libffi autoconf automake libtool openssl
Installation
------------
Populus can be installed using ``pip`` as follows.
.. code-block:: shell
$ pip install populus
Installation from source can be done from the root of the project with the
following command.
.. code-block:: shell
$ python setup.py install
Initializing a new project
--------------------------
Populus can initialize your project using the ``$ populus init`` command.
.. code-block:: shell
$ populus init
Created Directory: ./contracts
Created Example Contract: ./contracts/Greeter.sol
Created Directory: ./tests
Created Example Tests: ./tests/test_greeter.py
Your project will now have a ``./contracts`` directory with a single Solidity
source file in it named ``Greeter.sol``, as well as a ``./tests`` directory
with a single test file named ``test_greeter.py``.
Compiling your contracts
------------------------
Before you compile our project, lets take a look at the ``Greeter`` contract
that is generated as part of the project initialization.
.. code-block:: solidity
contract Greeter {
string public greeting;
function Greeter() {
greeting = "Hello";
}
function setGreeting(string _greeting) public {
greeting = _greeting;
}
function greet() constant returns (string) {
return greeting;
}
}
``Greeter`` is simple contract that is initialized with a default greeting of
the string ``'Hello'``. It exposes the ``greet`` function which returns
whatever string is set as the greeting, as well as a ``setGreeting`` function
which allows the greeting to be changed.
You can now compile the contract using ``$ populus compile``
.. code-block:: shell
$ populus compile
============ Compiling ==============
> Loading source files from: ./contracts
> Found 1 contract source files
- contracts/Greeter.sol
> Compiled 1 contracts
- Greeter
> Wrote compiled assets to: ./build/contracts.json
Testing your contract
---------------------
Now that you have a basic contract you'll want to test that it behaves as
expected. The project should already have a test module named
``test_greeter.py`` located in the ``./tests`` directory that looks like the
following.
.. code-block:: python
def test_greeter(chain):
greeter = chain.get_contract('Greeter')
greeting = greeter.call().greet()
assert greeting == 'Hello'
def test_custom_greeting(chain):
greeter = chain.get_contract('Greeter')
set_txn_hash = greeter.transact().setGreeting('Guten Tag')
chain.wait.for_receipt(set_txn_hash)
greeting = greeter.call().greet()
assert greeting == 'Guten Tag'
You should see two tests, one that tests the default greeting, and one that
tests that we can set a custom greeting.
.. _Go Ethereum: https://github.com/ethereum/go-ethereum/
.. _Solidity: https://github.com/ethereum/solidity/
.. _PyEthereum: https://github.com/ethereum/pyethereum/

18
requirements-docs.txt Normal file
View File

@ -0,0 +1,18 @@
# empty to prevent failure due to system dependency requirements
mock
sphinx-better-theme>=0.1.4
#
# actual requirements
#
click>=5.1
configparser==3.5.0
contextlib2>=0.5.4
#eth-testrpc>=0.8.0
#ethereum-tester-client>=1.1.0
gevent>=1.1.2
py-geth>=1.1.0
py-solc>=0.4.0
#pysha3>=0.3
pytest>=2.7.2
toposort>=1.4
web3>=2.1.0