diff --git a/latest/.doctrees/commands/networks.doctree b/latest/.doctrees/commands/networks.doctree index a992b33ba9..3716838897 100644 Binary files a/latest/.doctrees/commands/networks.doctree and b/latest/.doctrees/commands/networks.doctree differ diff --git a/latest/.doctrees/environment.pickle b/latest/.doctrees/environment.pickle index d412fb5e8c..992a06827b 100644 Binary files a/latest/.doctrees/environment.pickle and b/latest/.doctrees/environment.pickle differ diff --git a/latest/.doctrees/methoddocs/ape.doctree b/latest/.doctrees/methoddocs/ape.doctree index a52299f5a5..2b56e947c9 100644 Binary files a/latest/.doctrees/methoddocs/ape.doctree and b/latest/.doctrees/methoddocs/ape.doctree differ diff --git a/latest/.doctrees/methoddocs/ape_accounts.doctree b/latest/.doctrees/methoddocs/ape_accounts.doctree index 6553bbda60..b354562607 100644 Binary files a/latest/.doctrees/methoddocs/ape_accounts.doctree and b/latest/.doctrees/methoddocs/ape_accounts.doctree differ diff --git a/latest/.doctrees/methoddocs/ape_compile.doctree b/latest/.doctrees/methoddocs/ape_compile.doctree index 7470305ff0..d2759bfe39 100644 Binary files a/latest/.doctrees/methoddocs/ape_compile.doctree and b/latest/.doctrees/methoddocs/ape_compile.doctree differ diff --git a/latest/.doctrees/methoddocs/ape_ethereum.doctree b/latest/.doctrees/methoddocs/ape_ethereum.doctree index 41d1041923..cfa6e2570c 100644 Binary files a/latest/.doctrees/methoddocs/ape_ethereum.doctree and b/latest/.doctrees/methoddocs/ape_ethereum.doctree differ diff --git a/latest/.doctrees/methoddocs/ape_node.doctree b/latest/.doctrees/methoddocs/ape_node.doctree index 4e4e48db43..aae17bf57f 100644 Binary files a/latest/.doctrees/methoddocs/ape_node.doctree and b/latest/.doctrees/methoddocs/ape_node.doctree differ diff --git a/latest/.doctrees/methoddocs/ape_pm.doctree b/latest/.doctrees/methoddocs/ape_pm.doctree index 19ac4339f0..56af6ad441 100644 Binary files a/latest/.doctrees/methoddocs/ape_pm.doctree and b/latest/.doctrees/methoddocs/ape_pm.doctree differ diff --git a/latest/.doctrees/methoddocs/ape_test.doctree b/latest/.doctrees/methoddocs/ape_test.doctree index e138818ead..a27b23d28c 100644 Binary files a/latest/.doctrees/methoddocs/ape_test.doctree and b/latest/.doctrees/methoddocs/ape_test.doctree differ diff --git a/latest/.doctrees/methoddocs/api.doctree b/latest/.doctrees/methoddocs/api.doctree index a635f9c0a2..c9bd88995b 100644 Binary files a/latest/.doctrees/methoddocs/api.doctree and b/latest/.doctrees/methoddocs/api.doctree differ diff --git a/latest/.doctrees/methoddocs/cli.doctree b/latest/.doctrees/methoddocs/cli.doctree index aa8a7d56d8..39b4341386 100644 Binary files a/latest/.doctrees/methoddocs/cli.doctree and b/latest/.doctrees/methoddocs/cli.doctree differ diff --git a/latest/.doctrees/methoddocs/contracts.doctree b/latest/.doctrees/methoddocs/contracts.doctree index 9d419ac1d1..84381e4981 100644 Binary files a/latest/.doctrees/methoddocs/contracts.doctree and b/latest/.doctrees/methoddocs/contracts.doctree differ diff --git a/latest/.doctrees/methoddocs/exceptions.doctree b/latest/.doctrees/methoddocs/exceptions.doctree index ccf93ed1eb..7df5d2f4a1 100644 Binary files a/latest/.doctrees/methoddocs/exceptions.doctree and b/latest/.doctrees/methoddocs/exceptions.doctree differ diff --git a/latest/.doctrees/methoddocs/managers.doctree b/latest/.doctrees/methoddocs/managers.doctree index ff26ba6e04..7c016ee51e 100644 Binary files a/latest/.doctrees/methoddocs/managers.doctree and b/latest/.doctrees/methoddocs/managers.doctree differ diff --git a/latest/.doctrees/methoddocs/plugins.doctree b/latest/.doctrees/methoddocs/plugins.doctree index db55967910..fda70359ab 100644 Binary files a/latest/.doctrees/methoddocs/plugins.doctree and b/latest/.doctrees/methoddocs/plugins.doctree differ diff --git a/latest/.doctrees/methoddocs/types.doctree b/latest/.doctrees/methoddocs/types.doctree index 9459e382e2..404b2d8a14 100644 Binary files a/latest/.doctrees/methoddocs/types.doctree and b/latest/.doctrees/methoddocs/types.doctree differ diff --git a/latest/.doctrees/methoddocs/utils.doctree b/latest/.doctrees/methoddocs/utils.doctree index 0fc95fddf0..b77090718b 100644 Binary files a/latest/.doctrees/methoddocs/utils.doctree and b/latest/.doctrees/methoddocs/utils.doctree differ diff --git a/latest/.doctrees/userguides/dependencies.doctree b/latest/.doctrees/userguides/dependencies.doctree index c3a5db1e4e..f32aa54459 100644 Binary files a/latest/.doctrees/userguides/dependencies.doctree and b/latest/.doctrees/userguides/dependencies.doctree differ diff --git a/latest/_sources/userguides/dependencies.md.txt b/latest/_sources/userguides/dependencies.md.txt index 563950f8be..97ec6d3e8e 100644 --- a/latest/_sources/userguides/dependencies.md.txt +++ b/latest/_sources/userguides/dependencies.md.txt @@ -73,22 +73,22 @@ dependencies: When using the `pypi:` key, dependencies are downloaded and extracted from PyPI using an HTTP requests library. -You can also specify the `python:` key for already-installed dependencies: +You can also specify the `site_package:` key for already-installed dependencies: ```yaml dependencies: - - python: snekmate + - site_package: snekmate config_override: contracts_folder: . ``` -Using `python:` requires the package to be installed in your `sys.path` (site-packages) folder, generally via `pip` or some other tool. +Using `site_package:` requires the package to be installed in your `sys.path` (site-packages) folder, generally via `pip` or some other tool. The `contracts_folder` override, in this case, is often needed because the site-package does not have the root source-folder included. -Additionally, `python:` specified dependencies may also be lacking project-configuration files, such as the `ape-config.yaml`. +Additionally, `site_package:` specified dependencies may also be lacking project-configuration files, such as the `ape-config.yaml`. Compilers such as `vyper` encourage users to use `pip` to publish and install smart-contract dependencies (other vyper files), but some features in Ape may be limited if the dependency is not also specified in your config somewhere. -If wanting to use a dependency from `PyPI`, we recommend using the `pypi:` key instead of the `python:` key. -However, the `python:` key works great if you already used `pip` to install the dependency, especially if the dependency is not available on `PyPI`. +If wanting to use a dependency from `PyPI`, we recommend using the `pypi:` key instead of the `site_package:` key. +However, the `site_package:` key works great if you already used `pip` to install the dependency, especially if the dependency is not available on `PyPI`. ### Local diff --git a/latest/commands/networks.html b/latest/commands/networks.html index f69f9902f6..ce4dc23690 100644 --- a/latest/commands/networks.html +++ b/latest/commands/networks.html @@ -193,7 +193,7 @@
Filter the results by ecosystem
celo | apechain | bttc | kroma | shibarium | gnosis | world-chain | zetachain | polygon | cronos | geist | palm | unichain | arbitrum | fraxtal | rootstock | ethereum | lumia | fantom | crossfi | blast | cronos-zkevm | flow-evm | xai | polygon-zkevm | optimism | scroll | bsc | xmtp | polynomial | moonbeam | taiko | zksync | abstract | base | astar | metis | wemix | berachain | avalanche | soneium | mantle | lens | shape | zora | oort | linea
+polygon-zkevm | base | crossfi | moonbeam | polygon | zksync | zora | flow-evm | taiko | shibarium | geist | fraxtal | gnosis | astar | bttc | kroma | cronos-zkevm | berachain | lens | optimism | ethereum | unichain | arbitrum | mantle | zetachain | linea | world-chain | apechain | bsc | polynomial | cronos | shape | abstract | soneium | avalanche | metis | blast | xmtp | fantom | xai | rootstock | oort | palm | celo | wemix | lumia | scroll
Filter the results by network
opbnb-testnet-fork | mainnet-fork | fuji | chiado-fork | alfajores-fork | amoy | donau-fork | holesky-fork | hekla-fork | sepolia | polter-fork | moonriver-fork | fuji-fork | donau | dev-fork | sepolia-fork | moonriver | cardona-fork | curtis-fork | opbnb-fork | puppynet-fork | testnet | nova-fork | chiado | testnet-fork | nova | local | cardona | dev | prism-fork | opbnb-testnet | mumbai-fork | moonbase-fork | holesky | curtis | hekla | alfajores | minato-fork | goerli | minato | goerli-fork | puppynet | bartio-fork | prism | opbnb | amoy-fork | bartio | mumbai | moonbase | polter | mainnet
+prism-fork | dev | minato-fork | alfajores-fork | opbnb | goerli | sepolia-fork | chiado | polter | bartio | sepolia | moonriver-fork | moonbase-fork | local | moonriver | opbnb-testnet-fork | holesky-fork | puppynet-fork | goerli-fork | minato | bartio-fork | opbnb-fork | fuji | chiado-fork | hekla | polter-fork | mumbai | mainnet-fork | nova-fork | donau-fork | holesky | cardona | hekla-fork | amoy | mainnet | curtis-fork | puppynet | testnet-fork | donau | cardona-fork | nova | moonbase | curtis | dev-fork | opbnb-testnet | mumbai-fork | fuji-fork | testnet | prism | alfajores | amoy-fork
Filter the results by provider
node | test
+test | node
Configure your node:
in Ape, the default provider
plugin for live-network nodes. Also, ape node
can
start-up a local development node for testing purposes.
fetch()
package_id
pypi
python
site_package
uri
version
version_id
A dependency installed from Python tooling, such as pip.
The Python site-package name, such as "snekmate"
. Cannot use
with pypi:
. Requires the dependency to have been installed
either via pip
or something alike.
When using the pypi:
key, dependencies are downloaded and extracted from PyPI using an HTTP requests library.
You can also specify the python:
key for already-installed dependencies:
You can also specify the site_package:
key for already-installed dependencies:
dependencies:
- - python: snekmate
+ - site_package: snekmate
config_override:
contracts_folder: .
Using python:
requires the package to be installed in your sys.path
(site-packages) folder, generally via pip
or some other tool.
+
Using site_package:
requires the package to be installed in your sys.path
(site-packages) folder, generally via pip
or some other tool.
The contracts_folder
override, in this case, is often needed because the site-package does not have the root source-folder included.
-Additionally, python:
specified dependencies may also be lacking project-configuration files, such as the ape-config.yaml
.
+Additionally, site_package:
specified dependencies may also be lacking project-configuration files, such as the ape-config.yaml
.
Compilers such as vyper
encourage users to use pip
to publish and install smart-contract dependencies (other vyper files), but some features in Ape may be limited if the dependency is not also specified in your config somewhere.
If wanting to use a dependency from PyPI
, we recommend using the pypi:
key instead of the python:
key.
-However, the python:
key works great if you already used pip
to install the dependency, especially if the dependency is not available on PyPI
.
If wanting to use a dependency from PyPI
, we recommend using the pypi:
key instead of the site_package:
key.
+However, the site_package:
key works great if you already used pip
to install the dependency, especially if the dependency is not available on PyPI
.