mirror of
https://github.com/FlipsideCrypto/web3.py.git
synced 2026-02-06 10:56:47 +00:00
81 lines
2.0 KiB
ReStructuredText
81 lines
2.0 KiB
ReStructuredText
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``
|