feat: added option to generate basic ape-config.yaml file if [tool.ape.plugins] property is specified inside pyproject.toml file [APE-1312]

[Aviksaikat]

…

What I did

Added option to specify plugins in the ape-config.yaml file based on the [tool.ape.plugins] property of pyproject.toml file.

fixes: #1571

How I did it

Added functions for parsing the pyproject.toml file & look for lines which have the ape- initials & then stripping them & put them inside the ape-config.yaml file with proper formatting

How to verify it

1. Create a new folder with this pyproject.toml file

[tool.poetry]
name = "testing ape-config"
version = "0.1.0"
description = ""
authors = ["Your Name <[email protected]>"]
readme = "README.md"
packages = [{include = "Flash_loan_arbritage"}]

[tool.poetry.dependencies]
python = ">=3.10,<3.11"
eth-ape = "*"
ape-alchemy = "^0.6.2"
ape-solidity= "^0.6.7"
ape-foundry = "^0.6.14"
ape-etherscan = "*"


[tool.ape.plugins]
ape-alchemy = "*"
ape-solidity = "*"
ape-foundry = "*"
ape-etherscan = "*"

# working on adding support for this property
[tool.ape.network]
ecosystem = "ethereum"
default_network = "mainnet-fork"
default_provider = "foundry"

# working on adding support for this property
[tool.ape.tests]
mnemonic = "test test test test test test test test test test test junk"
number_of_test_accounts = 10

[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"

2. Then create a new virtual environment by doing poetry install && poetry shell
3. Then run pip install -e <path/to/the/cloned/repo/with/this/revision/
4. Then run ape init
5. Done

POC

Checklist

• All changes are completed
• New test cases have been added
• Documentation has been updated

[antazoey]

Some missing things,
and I think there is a helpful standard library to assist with this and simplify the code we have to manage

[antazoey]

nice work but things are in the wrong spot and we should be configuring the tool directly instead of generating a config from a config

[antazoey]

this should all happen in the config manage, not in ape-init plugin.
And then you can use the project_manager.path as the base here instead of cwd

[antazoey]

instead of writing an ape file, the ConfigManager should read the values from the pyproject.toml and treat it the same as if the config file had existed. There is not reason to configure twice, even if one is auto-generated.

[github-actions]

This pull request is considered stale because it has been open 30 days with no activity. Remove stale label, add a comment, or make a new commit, otherwise this PR will be closed in 5 days.

[Aviksaikat]

any update on this one ?

[antazoey]

any update on this one ?

There is a quite a lot of unaddressed feedback. Basically, we want this to be another source of config rather than creating a config file from it

[Aviksaikat]

so let's make it a draft and wait for further feedback?

[antazoey]

so let's make it a draft and wait for further feedback?

We are not able to provide any more feedback until the approach matches more with the design of having the pyproject.toml be source of config rather than it generating a new config file.

[fubuloubu]

so let's make it a draft and wait for further feedback?

We are not able to provide any more feedback until the approach matches more with the design of having the pyproject.toml be source of config rather than it generating a new config file.

to expand on this, make it look something like this I suppose:

[tools.ape]
plugins = [
    etherscan,
    vyper,
]

[github-actions]

This pull request is considered stale because it has been open 30 days with no activity. Remove stale label, add a comment, or make a new commit, otherwise this PR will be closed in 5 days.

[fubuloubu]

I think this approach should be closed for now. I am in favor of migrating the ape-config.yaml file actually into pyproject.toml but it needs a lot of further thought