Metadata-Version: 2.1
Name: ape-vyper
Version: 0.5.1
Summary: Plugin for Ape Ethereum Framework for compiling Vyper contracts
Home-page: https://github.com/ApeWorX/ape-vyper
Author: ApeWorX Ltd.
Author-email: admin@apeworx.io
License: Apache-2.0
Description: # Quick Start
        
        Ape compiler plugin around [VVM](https://github.com/vyperlang/vvm)
        
        ## Dependencies
        
        * [python3](https://www.python.org/downloads) version 3.8 or greater, python3-dev
        
        ## Installation
        
        ### via `pip`
        
        You can install the latest release via [`pip`](https://pypi.org/project/pip/):
        
        ```bash
        pip install ape-vyper
        ```
        
        ### via `setuptools`
        
        You can clone the repository and use [`setuptools`](https://github.com/pypa/setuptools) for the most up-to-date version:
        
        ```bash
        git clone https://github.com/ApeWorX/ape-vyper.git
        cd ape-vyper
        python3 setup.py install
        ```
        
        ## Quick Usage
        
        First, place Vyper contract source files (files with extension `.vy`) in your Ape project's contracts folder.
        An example Vyper contract can be found [here](https://vyper.readthedocs.io/en/stable/vyper-by-example.html).
        Then, from your root Ape project folder, run the command:
        
        ```bash
        ape compile
        ```
        
        The `.vy` files in your project will compile into `ContractTypes` that you can deploy and interact with in Ape.
        
        ### Interfaces
        
        You can not compile interface source files directly.
        Thus, you must place interface files in a directory named `interfaces` in your `contracts_folder` e.g. `contracts/interfaces/IFace.vy`.
        Then, these files can be imported in other `.vy` sources files via:
        
        ```python
        import interfaces.IFace as IFace
        ```
        
Keywords: ethereum
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Requires-Python: >=3.8,<3.11
Description-Content-Type: text/markdown
Provides-Extra: test
Provides-Extra: lint
Provides-Extra: release
Provides-Extra: dev
