diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml new file mode 100644 index 00000000..a1b90199 --- /dev/null +++ b/.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 diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml new file mode 100644 index 00000000..4e0922f0 --- /dev/null +++ b/.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 ./ ./tests ./setup.py + + - name: Run isort + run: isort --recursive --check-only --diff ./ ./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 + + 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 diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..8a507efc --- /dev/null +++ b/.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 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 00000000..8598f9c8 --- /dev/null +++ b/.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 diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..1798a178 --- /dev/null +++ b/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/) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..62569b6f --- /dev/null +++ b/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/.git +cd + +# 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. diff --git a/LICENSE b/LICENSE new file mode 100644 index 00000000..735751e7 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2021 ApeWorX Ltd. + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 00000000..bc6182d1 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# + +TODO: Description + +## Dependencies + +* [python3](https://www.python.org/downloads) version 3.6 or greater, python3-dev + +## Installation + +### via `pip` + +You can install the latest release via [`pip`](https://pypi.org/project/pip/): + +```bash +pip install +``` + +### 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/.git +cd +python3 setup.py install +``` + +## Quick Usage + +TODO: Describe library overview in code + +## Development + +This project is in early development and should be considered an alpha. +Things might not work, breaking changes are likely. +Comments, questions, criticisms and pull requests are welcomed. + +## License + +This project is licensed under the [Apache 2.0](LICENSE). diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 00000000..54ef9925 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,52 @@ +[build-system] +requires = ["setuptools>=51.1.1", "wheel", "setuptools_scm[toml]>=5.0"] + +[tool.setuptools_scm] +write_to = "/version.py" + +# NOTE: you have to use single-quoted strings in TOML for regular expressions. +# It's the equivalent of r-strings in Python. Multiline strings are treated as +# verbose regular expressions by Black. Use [ ] to denote a significant space +# character. + +[tool.black] +line-length = 100 +target-version = ['py36', 'py37', 'py38'] +include = '\.pyi?$' +exclude = ''' +/( + \.eggs + | \.git + | \.hg + | \.mypy_cache + | \.tox + | \.venv + | _build + | build + | dist + | env + | venv +)/ +''' + +[tool.pytest.ini_options] +addopts = """ + -n auto + --cov-branch + --cov-report term + --cov-report html + --cov-report xml + --cov= +""" +python_files = "test_*.py" +testpaths = "tests" +markers = "fuzzing: Run Hypothesis fuzz test suite" + +[tool.isort] +line_length = 100 +force_grid_wrap = 0 +include_trailing_comma = true +known_third_party = ["hypothesis"] +known_first_party = ["MODULE_NAME"] +multi_line_output = 3 +use_parentheses = true diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 00000000..1c2ef4d5 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,6 @@ +[flake8] +max-line-length = 100 +exclude = + venv* + docs + build diff --git a/setup.py b/setup.py new file mode 100644 index 00000000..a9b85409 --- /dev/null +++ b/setup.py @@ -0,0 +1,91 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +from setuptools import ( # type: ignore + setup, + find_packages, +) + +extras_require = { + "test": [ # `test` GitHub Action jobs uses this + "pytest>=6.0,<7.0", # Core testing package + "pytest-xdist", # multi-process runner + "pytest-cov", # Coverage analyzer plugin + ], + "fuzz": [ # `fuzz` GitHub Action job uses this + "hypothesis>=6.2.0,<7.0", # Strategy-based fuzzer + ], + "lint": [ + "black>=20.8b1,<21.0", # auto-formatter and linter + "mypy>=0.800,<1.0", # Static type analyzer + "isort>=5.7.0,<6.0", # Import sorting linter + ], + "doc": [ + "Sphinx>=3.4.3,<4", # Documentation generator + "sphinx_rtd_theme>=0.1.9,<1", # Readthedocs.org theme + "towncrier>=19.2.0, <20", # Generate release notes + ], + "release": [ # `release` GitHub Action job uses this + "setuptools", # Installation tool + "setuptools-scm", # Installation tool + "wheel", # Packaging tool + "twine", # Package upload tool + ], + "dev": [ + "commitizen", # Manage commits and publishing releases + "pytest-watch", # `ptw` test watcher/runner + "IPython", # Console for interacting + "ipdb", # Debugger (Must use `export PYTHONBREAKPOINT=ipdb.set_trace`) + ], +} + +# NOTE: `pip install -e .[dev]` to install package +extras_require["dev"] = ( + extras_require["test"] + + extras_require["fuzz"] + + extras_require["lint"] + + extras_require["doc"] + + extras_require["release"] + + extras_require["dev"] +) + +# NOTE: This comes after the previous so we don't have double dependencies +extras_require["fuzz"] = extras_require["test"] + extras_require["fuzz"] + +with open("./README.md") as readme: + long_description = readme.read() + + +setup( + name="", + use_scm_version=True, + setup_requires=['setuptools_scm'], + description=""": """, + long_description=long_description, + long_description_content_type="text/markdown", + author="ApeWorX Ltd.", + author_email="admin@apeworx.io", + url="https://github.com/ApeWorX/", + include_package_data=True, + install_requires=[], # NOTE: Add 3rd party libraries here + python_requires=">=3.6,<4", + extras_require=extras_require, + py_modules=[""], + license="Apache-2.0", + zip_safe=False, + keywords="ethereum", + packages=find_packages(exclude=["tests", "tests.*"]), + package_data={"": ["py.typed"]}, + classifiers=[ + "Development Status :: 3 - Alpha", + "Intended Audience :: Developers", + "License :: OSI Approved :: MIT License", + "Natural Language :: English", + "Operating System :: MacOS", + "Operating System :: POSIX", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.6", + "Programming Language :: Python :: 3.7", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + ], +)