Add basic project scaffolding functionality via CLI #78
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Just a simple WIP of scaffolding a new Tealish project with a template smart contract, test, and basic utility functions. This is achieved through a new CLI command called
start
(not entirely sold on the name but it's a start 😉).As part of the scaffold, there is a
tealish.json
file at the root level that contains configs. For now there is only a config for the name (and location) of the build directory that the_build()
function builds to. If the config does not exist, the standard name and location is used (build directory at the location of the Tealish file).Example Usage
tealish start my_tealish_project --template=algosdk
.cd
into the project root directory.tealish compile contracts
python3 -m unittest
(assumes algod, kmd, and indexer are running on default Sandbox ports)Thoughts
start
.start
should be enforced, e.g., build, contracts, tests directories, and config file all at root level. This makes it easier to reason about the location of certain files when creating new CLI features. However, the names of each directory should be configurable via the config file (like with the build directory).requirements.txt
in the scaffold for the sake of simplicity but we can of course choose to supportpyproject.toml
instead.