Initial commit

.github/workflows/publish.yaml

@@ -0,0 +1,32 @@
+name: Release
+
+on:
+  release:
+    types: [released]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.8
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .[release]
+        
+    - name: Build
+      run: python setup.py sdist bdist_wheel
+
+    - name: Publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: twine upload dist/* --verbose

.github/workflows/test.yaml

@@ -0,0 +1,85 @@
+on: ["push", "pull_request"]
+
+name: Test
+
+jobs:
+    linting:
+        runs-on: ubuntu-latest
+
+        steps:
+        - uses: actions/checkout@v2
+
+        - name: Setup Python
+          uses: actions/setup-python@v2
+          with:
+              python-version: 3.8
+
+        - name: Install Dependencies
+          run: pip install .[lint]
+
+        - name: Run Black
+          run: black --check .
+
+        - name: Run flake8
+          run: flake8 ./<MODULE_NAME> ./tests ./setup.py
+
+        - name: Run isort
+          run: isort --recursive --check-only --diff ./<MODULE_NAME> ./tests
+
+    type-check:
+        runs-on: ubuntu-latest
+
+        steps:
+        - uses: actions/checkout@v2
+
+        - name: Setup Python
+          uses: actions/setup-python@v2
+          with:
+              python-version: 3.8
+
+        - name: Install Dependencies
+          run: pip install .[lint]
+
+        - name: Run MyPy
+          run: mypy -p <MODULE_NAME>
+
+    functional:
+        runs-on: ubuntu-latest
+
+        strategy:
+            matrix:
+                python-version: [3.6, 3.7, 3.8]
+
+        steps:
+        - uses: actions/checkout@v2
+
+        - name: Setup Python
+          uses: actions/setup-python@v2
+          with:
+              python-version: ${{ matrix.python-version }}
+
+        - name: Install Dependencies
+          run: pip install .[test]
+
+        - name: Run Tests
+          run: pytest -m "not fuzzing" -s --coverage
+
+    fuzzing:
+        runs-on: ubuntu-latest
+
+        strategy:
+            fail-fast: true
+
+        steps:
+        - uses: actions/checkout@v2
+
+        - name: Setup Python
+          uses: actions/setup-python@v2
+          with:
+              python-version: 3.8
+
+        - name: Install Dependencies
+          run: pip install .[test]
+
+        - name: Run Tests
+          run: pytest -m "fuzzing" --no-cov -s

.gitignore

@@ -0,0 +1,115 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json

.pre-commit-config.yaml

@@ -0,0 +1,35 @@
+repos:
+-   repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.1.0
+    hooks:
+    -   id: check-yaml
+
+-   repo: https://github.com/asottile/seed-isort-config
+    rev: v2.2.0
+    hooks:
+    -   id: seed-isort-config
+
+-   repo: https://github.com/pre-commit/mirrors-isort
+    rev: v4.3.21
+    hooks:
+      - id: isort
+
+-   repo: https://github.com/psf/black
+    rev: 20.8b0
+    hooks:
+      - id: black
+        name: black
+
+-   repo: https://gitlab.com/pycqa/flake8
+    rev: 3.8.3
+    hooks:
+    -   id: flake8
+
+-   repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.800
+    hooks:
+    -   id: mypy
+
+
+default_language_version:
+    python: python3

CHANGELOG.md

@@ -0,0 +1,8 @@
+# CHANGELOG
+
+All notable changes to this project are documented in this file.
+
+This changelog format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased](https://github.com/ApeWorX/<PROJECT_NAME>)

CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# Development
+
+To get started with working on the codebase, use the following steps prepare your local environment:
+
+```bash
+# clone the github repo and navigate into the folder
+git clone https://github.com/ApeWorX/<PROJECT_NAME>.git
+cd <PROJECT_NAME>
+
+# create and load a virtual environment
+python3 -m venv venv
+source venv/bin/activate
+
+# install brownie into the virtual environment
+python setup.py install
+
+# install the developer dependencies (-e is interactive mode)
+pip install -e .[dev]
+```
+
+## Pre-Commit Hooks
+
+We use [`pre-commit`](https://pre-commit.com/) hooks to simplify linting and ensure consistent formatting among contributors.
+Use of `pre-commit` is not a requirement, but is highly recommended.
+
+Install `pre-commit` locally from the root folder:
+
+```bash
+pip install pre-commit
+pre-commit install
+```
+
+Commiting will now automatically run the local hooks and ensure that your commit passes all lint checks.
+
+## Pull Requests
+
+Pull requests are welcomed! Please adhere to the following:
+
+- Ensure your pull request passes our linting checks
+- Include test cases for any new functionality
+- Include any relevant documentation updates
+
+It's a good idea to make pull requests early on.
+A pull request represents the start of a discussion, and doesn't necessarily need to be the final, finished submission.
+
+If you are opening a work-in-progress pull request to verify that it passes CI tests, please consider
+[marking it as a draft](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests).
+
+Join the Ethereum Python [Discord](https://discord.gg/PcEJ54yX) if you have any questions.