From cdd2f3ab8d84680c9a7c978df65231ed8557e2fd Mon Sep 17 00:00:00 2001 From: Alexey Safonov Date: Tue, 12 Dec 2023 17:54:02 +0300 Subject: [PATCH] Initial commit --- .github/ISSUE_TEMPLATE/bug.md | 32 +++++ .github/ISSUE_TEMPLATE/feature.md | 22 +++ .github/ISSUE_TEMPLATE/work-item.md | 48 +++++++ .github/PULL_REQUEST_TEMPLATE.md | 16 +++ .github/release-drafter.yml | 37 +++++ .github/workflows/codeql.yaml | 34 +++++ .github/workflows/commitlint.yaml | 25 ++++ .github/workflows/draft.yaml | 19 +++ .github/workflows/prtitle.yaml | 28 ++++ .github/workflows/publish.yaml | 32 +++++ .github/workflows/test.yaml | 103 ++++++++++++++ .gitignore | 125 +++++++++++++++++ .pre-commit-config.yaml | 36 +++++ CONTRIBUTING.md | 49 +++++++ LICENSE | 201 ++++++++++++++++++++++++++++ MODULE_NAME/__init__.py | 1 + MODULE_NAME/py.typed | 0 README.md | 36 +++++ pyproject.toml | 42 ++++++ setup.cfg | 7 + setup.py | 85 ++++++++++++ tests/__init__.py | 0 22 files changed, 978 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug.md create mode 100644 .github/ISSUE_TEMPLATE/feature.md create mode 100644 .github/ISSUE_TEMPLATE/work-item.md create mode 100644 .github/PULL_REQUEST_TEMPLATE.md create mode 100644 .github/release-drafter.yml create mode 100644 .github/workflows/codeql.yaml create mode 100644 .github/workflows/commitlint.yaml create mode 100644 .github/workflows/draft.yaml create mode 100644 .github/workflows/prtitle.yaml create mode 100644 .github/workflows/publish.yaml create mode 100644 .github/workflows/test.yaml create mode 100644 .gitignore create mode 100644 .pre-commit-config.yaml create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE create mode 100644 MODULE_NAME/__init__.py create mode 100644 MODULE_NAME/py.typed create mode 100644 README.md create mode 100644 pyproject.toml create mode 100644 setup.cfg create mode 100644 setup.py create mode 100644 tests/__init__.py diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md new file mode 100644 index 0000000..91fc385 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Report an error that you've encountered. +labels: bug +--- + +### Environment information + +- `ape` and plugin versions: + +``` +$ ape --version +# ...copy and paste result of above command here... + +$ ape plugins list +# ...copy and paste result of above command here... +``` + +- Python Version: x.x.x +- OS: osx/linux/win + +### What went wrong? + +Please include information like: + +- what command you ran +- the code that caused the failure (see [this link](https://help.github.com/articles/basic-writing-and-formatting-syntax/) for help with formatting code) +- full output of the error you received + +### How can it be fixed? + +Fill this in if you have ideas on how the bug could be fixed. diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md new file mode 100644 index 0000000..1b56056 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.md @@ -0,0 +1,22 @@ +--- +name: Feature request +about: Request a new feature, or an improvement to existing functionality. +labels: enhancement +--- + +### Overview + +Provide a simple overview of what you wish to see added. Please include: + +- What you are trying to do +- Why Ape's current functionality is inadequate to address your goal + +### Specification + +Describe the syntax and semantics of how you would like to see this feature implemented. The more detailed the better! + +Remember, your feature is much more likely to be included if it does not involve any breaking changes. + +### Dependencies + +Include links to any open issues that must be resolved before this feature can be implemented. diff --git a/.github/ISSUE_TEMPLATE/work-item.md b/.github/ISSUE_TEMPLATE/work-item.md new file mode 100644 index 0000000..1932055 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/work-item.md @@ -0,0 +1,48 @@ +--- +name: Work item +about: New work item for Ape team +labels: backlog +--- + +### Elevator pitch: + + + +### Value: + + + +### Dependencies: + + + +### Design approach: + + + +### Task list: + + + +- [ ] Tasks go here + +### Estimated completion date: + +### Design review: + + + +Do not signoff unless: + +- 1. agreed the tasks and design approach will achieve acceptance, and +- 2. the work can be completed by one person within the SLA. + Design reviewers should consider simpler approaches to achieve goals. + +(Please leave a comment to sign off) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..544cbc6 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,16 @@ +### What I did + + + +fixes: # + +### How I did it + +### How to verify it + +### Checklist + +- [ ] Passes all linting checks (pre-commit and CI jobs) +- [ ] New test cases have been added and are passing +- [ ] Documentation has been updated +- [ ] PR title follows [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/) standard (will be automatically included in the changelog) diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml new file mode 100644 index 0000000..70b2a3f --- /dev/null +++ b/.github/release-drafter.yml @@ -0,0 +1,37 @@ +name-template: '$RESOLVED_VERSION' +tag-template: 'v$RESOLVED_VERSION' + +categories: + - title: 'Features' + labels: + - 'feat' + - title: 'Bug Fixes' + labels: + - 'fix' + - title: 'Other updates' + labels: + - 'refactor' + - 'chore' + - 'docs' + +change-template: '- $TITLE @$AUTHOR (#$NUMBER)' +change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks. + +version-resolver: + major: + labels: + - 'major' + minor: + labels: + - 'minor' + patch: + labels: + - 'patch' + default: patch + +template: | + ## Changes + + $CHANGES + + Special thanks to: $CONTRIBUTORS diff --git a/.github/workflows/codeql.yaml b/.github/workflows/codeql.yaml new file mode 100644 index 0000000..2cdc07b --- /dev/null +++ b/.github/workflows/codeql.yaml @@ -0,0 +1,34 @@ +name: "CodeQL" + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + strategy: + fail-fast: false + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + - name: Initialize CodeQL + uses: github/codeql-action/init@v2 + with: + languages: python + + - name: Autobuild + uses: github/codeql-action/autobuild@v2 + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v2 diff --git a/.github/workflows/commitlint.yaml b/.github/workflows/commitlint.yaml new file mode 100644 index 0000000..d63f5a2 --- /dev/null +++ b/.github/workflows/commitlint.yaml @@ -0,0 +1,25 @@ +on: push + +name: Commit Message + +# NOTE: Skip check on PR so as not to confuse contributors +# NOTE: Also install a PR title checker so we don't mess up merges +jobs: + check: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + + - name: Setup Python + uses: actions/setup-python@v4 + with: + python-version: "3.10" + + - name: Install Dependencies + run: pip install commitizen + + - name: Check commit history + run: cz check --rev-range $(git rev-list --all --reverse | head -1)..HEAD diff --git a/.github/workflows/draft.yaml b/.github/workflows/draft.yaml new file mode 100644 index 0000000..f136f49 --- /dev/null +++ b/.github/workflows/draft.yaml @@ -0,0 +1,19 @@ +name: Release Drafter + +on: + push: + branches: + - main + +jobs: + update-draft: + runs-on: ubuntu-latest + permissions: + contents: write + steps: + # Drafts your next Release notes as Pull Requests are merged into "main" + - uses: release-drafter/release-drafter@v5 + with: + disable-autolabeler: true + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/prtitle.yaml b/.github/workflows/prtitle.yaml new file mode 100644 index 0000000..a6cd3b0 --- /dev/null +++ b/.github/workflows/prtitle.yaml @@ -0,0 +1,28 @@ +name: PR Title + +on: + pull_request_target: + types: + - opened + - edited + - synchronize + +jobs: + check: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + + - name: Setup Python + uses: actions/setup-python@v4 + with: + python-version: "3.10" + + - name: Install Dependencies + run: pip install commitizen + + - name: Check PR Title + env: + TITLE: ${{ github.event.pull_request.title }} + run: cz check --message "$TITLE" diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml new file mode 100644 index 0000000..88b2e64 --- /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@v3 + + - name: Set up Python + uses: actions/setup-python@v4 + with: + python-version: "3.10" + + - 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 0000000..8883134 --- /dev/null +++ b/.github/workflows/test.yaml @@ -0,0 +1,103 @@ +on: ["push", "pull_request"] + +name: Test + +concurrency: + # Cancel older, in-progress jobs from the same PR, same workflow. + # use run_id if the job is triggered by a push to ensure + # push-triggered jobs to not get canceled. + group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }} + cancel-in-progress: true + +jobs: + linting: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + + - name: Setup Python + uses: actions/setup-python@v4 + with: + python-version: "3.10" + + - name: Install Dependencies + run: | + python -m pip install --upgrade pip + pip install .[lint] + + - name: Run Black + run: black --check . + + - name: Run isort + run: isort --check-only . + + - name: Run flake8 + run: flake8 . + + - name: Run mdformat + run: mdformat . --check + + type-check: + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + + - name: Setup Python + uses: actions/setup-python@v4 + with: + python-version: "3.10" + + - name: Install Dependencies + run: | + python -m pip install --upgrade pip + pip install .[lint,test] + + - name: Run MyPy + run: mypy . + + functional: + runs-on: ${{ matrix.os }} + + strategy: + matrix: + os: [ubuntu-latest, macos-latest] # eventually add `windows-latest` + python-version: [3.8, 3.9, "3.10", "3.11"] + + steps: + - uses: actions/checkout@v3 + + - name: Setup Python + uses: actions/setup-python@v4 + with: + python-version: ${{ matrix.python-version }} + + - name: Install Dependencies + run: | + python -m pip install --upgrade pip + pip install .[test] + + - name: Run Tests + run: pytest -m "not fuzzing" -n 0 -s --cov + +# NOTE: uncomment this block after you've marked tests with @pytest.mark.fuzzing +# fuzzing: +# runs-on: ubuntu-latest +# +# strategy: +# fail-fast: true +# +# steps: +# - uses: actions/checkout@v3 +# +# - name: Setup Python +# uses: actions/setup-python@v4 +# with: +# python-version: "3.10" +# +# - 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 0000000..7881af6 --- /dev/null +++ b/.gitignore @@ -0,0 +1,125 @@ +# 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 + +# setuptools-scm +version.py + +# Ape stuff +.build/ + +**/.DS_Store +*.swp +*.swo diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..818a71f --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,36 @@ +repos: +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.5.0 + hooks: + - id: check-yaml + +- repo: https://github.com/pre-commit/mirrors-isort + rev: v5.10.1 + hooks: + - id: isort + +- repo: https://github.com/psf/black + rev: 23.11.0 + hooks: + - id: black + name: black + +- repo: https://github.com/pycqa/flake8 + rev: 6.1.0 + hooks: + - id: flake8 + +- repo: https://github.com/pre-commit/mirrors-mypy + rev: v1.7.1 + hooks: + - id: mypy + additional_dependencies: [types-setuptools, pydantic] + +- repo: https://github.com/executablebooks/mdformat + rev: 0.7.17 + hooks: + - id: mdformat + additional_dependencies: [mdformat-gfm, mdformat-frontmatter] + +default_language_version: + python: python3 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..8e86220 --- /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 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 +``` + +Committing 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 ApeWorX [Discord](https://discord.gg/apeworx) if you have any questions. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..bec7ea6 --- /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 2022 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/MODULE_NAME/__init__.py b/MODULE_NAME/__init__.py new file mode 100644 index 0000000..57e12c5 --- /dev/null +++ b/MODULE_NAME/__init__.py @@ -0,0 +1 @@ +# Add module top-level imports here diff --git a/MODULE_NAME/py.typed b/MODULE_NAME/py.typed new file mode 100644 index 0000000..e69de29 diff --git a/README.md b/README.md new file mode 100644 index 0000000..ab397e7 --- /dev/null +++ b/README.md @@ -0,0 +1,36 @@ +# Quick Start + +TODO: Description + +## Dependencies + +- [python3](https://www.python.org/downloads) version 3.8 up to 3.11. + +## 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 + +Please see the [contributing guide](CONTRIBUTING.md) to learn more how to contribute to this project. +Comments, questions, criticisms and pull requests are welcomed. diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..9e8ace2 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,42 @@ +[build-system] +requires = ["setuptools>=51.1.1", "wheel", "setuptools_scm[toml]>=5.0"] + +[tool.mypy] +exclude = "build/" +plugins = ["pydantic.mypy"] + +[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 = ['py38', 'py39', 'py310', 'py311'] +include = '\.pyi?$' + +[tool.pytest.ini_options] +addopts = """ + -p no:ape_test + --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 +multi_line_output = 3 +use_parentheses = true + +[tool.mdformat] +number = true diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..c362920 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,7 @@ +[flake8] +max-line-length = 100 +exclude = + venv* + .eggs + docs + build diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..beedd3b --- /dev/null +++ b/setup.py @@ -0,0 +1,85 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +from setuptools import find_packages, setup + +extras_require = { + "test": [ # `test` GitHub Action jobs uses this + "pytest>=6.0", # Core testing package + "pytest-xdist", # Multi-process runner + "pytest-cov", # Coverage analyzer plugin + "hypothesis>=6.2.0,<7.0", # Strategy-based fuzzer + ], + "lint": [ + "black>=23.11.0,<24", # Auto-formatter and linter + "mypy>=1.7.1,<2", # Static type analyzer + "types-setuptools", # Needed for mypy type shed + "types-requests", # Needed for mypy type shed + "flake8>=6.1.0,<7", # Style linter + "flake8-breakpoint>=1.1.0,<2", # Detect breakpoints left in code + "flake8-print>=5.0.0,<6", # Detect print statements left in code + "isort>=5.10.1,<6", # Import sorting linter + "mdformat>=0.7.17", # Auto-formatter for markdown + "mdformat-gfm>=0.3.5", # Needed for formatting GitHub-flavored markdown + "mdformat-frontmatter>=0.4.1", # Needed for frontmatters-style headers in issue templates + "mdformat-pyproject>=0.0.1", # Allows configuring in pyproject.toml + ], + "release": [ # `release` GitHub Action job uses this + "setuptools", # Installation tool + "wheel", # Packaging tool + "twine", # Package upload tool + ], + "dev": [ + "commitizen", # Manage commits and publishing releases + "pre-commit", # Ensure that linters are run prior to committing + "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["lint"] + + extras_require["release"] + + extras_require["dev"] +) + +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=[], + python_requires=">=3.8,<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 :: 5 - Production/Stable", + "Intended Audience :: Developers", + "License :: OSI Approved :: Apache Software License", + "Natural Language :: English", + "Operating System :: MacOS", + "Operating System :: POSIX", + "Programming Language :: Python :: 3", + "Programming Language :: Python :: 3.8", + "Programming Language :: Python :: 3.9", + "Programming Language :: Python :: 3.10", + "Programming Language :: Python :: 3.11", + ], +) diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..e69de29