ApeWorX / ape-template

Plugin for working with Cookiecutter-based project templates
Apache License 2.0
12 stars 8 forks source link

Ape Template Plugin #1

Closed NotPeopling2day closed 2 years ago

NotPeopling2day commented 2 years ago

Overview

Create a custom CLI plugin for using Click with Cookiecutter. We want a cli command to install git repos to install templates of projects

ape template git_repo_name

Testing:

Specification

It is important that it stays as a 2nd class so it will not break ape core.

it is to let the new users be able to clone, compile, and deploy a simple project.

Ape-Template aim is to make it seamless and easy to make a project from start to finish.

That is why it need to be able to git clone, install plugins, compile, test, and deploy

Dependencies

It is dependent on ape plugins install plugins_rec which is a new feature coming to this to make it better

Related feature to include: https://github.com/ApeWorX/ape/issues/729

Ninjagod1251 commented 2 years ago

another feature that will be really nice to add to template is

ape plugins install plugin_script_reccomendations

which will be done in pugins core not here so it will be linked

Ninjagod1251 commented 2 years ago

adding https://github.com/ApeWorX/ape/issues/729 to this as a feature

antazoey commented 2 years ago

Done!

Ninjagod1251 commented 2 years ago

This has been completed and documented on the setup.py

#       Usage example: `pipx install eth-ape[recommended-plugins]`
    "recommended-plugins": [
        "ape-alchemy",  # Alchemy public network provider
        "ape-ens",  # ENS converter
        "ape-etherscan",  # Etherscan explorer plugin
        "ape-foundry",  # Foundry local and fork network EVM provider
        "ape-hardhat",  # Hardhat local and fork network EVM provider
        "ape-infura",  # Infura public network provider
        "ape-ledger",  # Ledger Nano S/X hardware wallet
        "ape-solidity",  # Solidity compiler support
        "ape-template",  # Cookiecutter template support
        "ape-tokens",  # Tokenlists converter
        "ape-trezor",  # Trezor Model T/One hardware wallet
        "ape-vyper",  # Vyper compiler support],