Initial commit.
This commit is contained in:
Jacques Wagener
parent
56e4b20080
commit
fd5df89d62
|
|
@ -1,6 +1,6 @@
|
|||
<MODULE_NAME>
|
||||
<PYPI_NAME>
|
||||
<REPO_NAME>
|
||||
<RTD_NAME>
|
||||
<PROJECT_NAME>
|
||||
<SHORT_DESCRIPTION>
|
||||
vdb
|
||||
vyper-debug
|
||||
vyper-debug
|
||||
vyper-debug
|
||||
vyper-debug
|
||||
Easy to use Vyper debugger | vdb
|
||||
|
|
|
|||
2
Makefile
2
Makefile
|
|
@ -27,7 +27,7 @@ lint:
|
|||
tox -elint
|
||||
|
||||
lint-roll:
|
||||
isort --recursive <MODULE_NAME> tests
|
||||
isort --recursive vdb tests
|
||||
$(MAKE) lint
|
||||
|
||||
test:
|
||||
|
|
|
|||
28
README.md
28
README.md
|
|
@ -1,25 +1,25 @@
|
|||
# <PROJECT_NAME>
|
||||
# vyper-debug
|
||||
|
||||
[](https://gitter.im/ethereum/<REPO_NAME>?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
[](https://circleci.com/gh/ethereum/<REPO_NAME>)
|
||||
[](https://badge.fury.io/py/<PYPI_NAME>)
|
||||
[](https://pypi.python.org/pypi/<PYPI_NAME>)
|
||||
[](http://<RTD_NAME>.readthedocs.io/en/latest/?badge=latest)
|
||||
[](https://gitter.im/ethereum/vyper-debug?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
||||
[](https://circleci.com/gh/ethereum/vyper-debug)
|
||||
[](https://badge.fury.io/py/vyper-debug)
|
||||
[](https://pypi.python.org/pypi/vyper-debug)
|
||||
[](http://vyper-debug.readthedocs.io/en/latest/?badge=latest)
|
||||
|
||||
|
||||
<SHORT_DESCRIPTION>
|
||||
Easy to use Vyper debugger | vdb
|
||||
|
||||
Read more in the [documentation on ReadTheDocs](https://<RTD_NAME>.readthedocs.io/). [View the change log](https://<RTD_NAME>.readthedocs.io/en/latest/releases.html).
|
||||
Read more in the [documentation on ReadTheDocs](https://vyper-debug.readthedocs.io/). [View the change log](https://vyper-debug.readthedocs.io/en/latest/releases.html).
|
||||
|
||||
## Quickstart
|
||||
|
||||
```sh
|
||||
pip install <PYPI_NAME>
|
||||
pip install vyper-debug
|
||||
```
|
||||
|
||||
## Developer Setup
|
||||
|
||||
If you would like to hack on <REPO_NAME>, please check out the
|
||||
If you would like to hack on vyper-debug, please check out the
|
||||
[Ethereum Development Tactical Manual](https://github.com/pipermerriam/ethereum-dev-tactical-manual)
|
||||
for information on how we do:
|
||||
|
||||
|
|
@ -33,8 +33,8 @@ for information on how we do:
|
|||
You can set up your dev environment with:
|
||||
|
||||
```sh
|
||||
git clone git@github.com:ethereum/<REPO_NAME>.git
|
||||
cd <REPO_NAME>
|
||||
git clone git@github.com:ethereum/vyper-debug.git
|
||||
cd vyper-debug
|
||||
virtualenv -p python3 venv
|
||||
. venv/bin/activate
|
||||
pip install -e .[dev]
|
||||
|
|
@ -48,7 +48,7 @@ Show flake8 errors on file change:
|
|||
|
||||
```sh
|
||||
# Test flake8
|
||||
when-changed -v -s -r -1 <MODULE_NAME>/ tests/ -c "clear; flake8 <MODULE_NAME> tests && echo 'flake8 success' || echo 'error'"
|
||||
when-changed -v -s -r -1 vdb/ tests/ -c "clear; flake8 vdb tests && echo 'flake8 success' || echo 'error'"
|
||||
```
|
||||
|
||||
Run multi-process tests in one command, but without color:
|
||||
|
|
@ -64,7 +64,7 @@ Run in one thread, with color and desktop notifications:
|
|||
|
||||
```sh
|
||||
cd venv
|
||||
ptw --onfail "notify-send -t 5000 'Test failure ⚠⚠⚠⚠⚠' 'python 3 test on <REPO_NAME> failed'" ../tests ../<MODULE_NAME>
|
||||
ptw --onfail "notify-send -t 5000 'Test failure ⚠⚠⚠⚠⚠' 'python 3 test on vyper-debug failed'" ../tests ../vdb
|
||||
```
|
||||
|
||||
### Release setup
|
||||
|
|
|
|||
14
docs/conf.py
14
docs/conf.py
|
|
@ -1,6 +1,6 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# <PROJECT_NAME> documentation build configuration file, created by
|
||||
# vyper-debug documentation build configuration file, created by
|
||||
# sphinx-quickstart on Thu Oct 16 20:43:24 2014.
|
||||
#
|
||||
# This file is execfile()d with the current directory set to its
|
||||
|
|
@ -53,7 +53,7 @@ source_suffix = '.rst'
|
|||
master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = '<PROJECT_NAME>'
|
||||
project = 'vyper-debug'
|
||||
copyright = '2018, Jason Carver, Piper Merriam'
|
||||
|
||||
__version__ = setup_version
|
||||
|
|
@ -189,7 +189,7 @@ html_static_path = ['_static']
|
|||
#html_file_suffix = None
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = '<MODULE_NAME>doc'
|
||||
htmlhelp_basename = 'vdbdoc'
|
||||
|
||||
|
||||
# -- Options for LaTeX output ---------------------------------------------
|
||||
|
|
@ -209,7 +209,7 @@ latex_elements = {
|
|||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
('index', '<MODULE_NAME>.tex', '<PROJECT_NAME> Documentation',
|
||||
('index', 'vdb.tex', 'vyper-debug Documentation',
|
||||
'Jason Carver', 'manual'),
|
||||
]
|
||||
|
||||
|
|
@ -239,7 +239,7 @@ latex_documents = [
|
|||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
('index', '<MODULE_NAME>', '<PROJECT_NAME> Documentation',
|
||||
('index', 'vdb', 'vyper-debug Documentation',
|
||||
['Jason Carver'], 1)
|
||||
]
|
||||
|
||||
|
|
@ -253,8 +253,8 @@ man_pages = [
|
|||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
('index', '<PROJECT_NAME>', '<PROJECT_NAME> Documentation',
|
||||
'Jason Carver', '<PROJECT_NAME>', '<SHORT_DESCRIPTION>',
|
||||
('index', 'vyper-debug', 'vyper-debug Documentation',
|
||||
'Jason Carver', 'vyper-debug', 'Easy to use Vyper debugger | vdb',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<PROJECT_NAME>
|
||||
vyper-debug
|
||||
==============================
|
||||
|
||||
<SHORT_DESCRIPTION>
|
||||
Easy to use Vyper debugger | vdb
|
||||
|
||||
Contents
|
||||
--------
|
||||
|
|
@ -9,7 +9,7 @@ Contents
|
|||
.. toctree::
|
||||
:maxdepth: 3
|
||||
|
||||
<MODULE_NAME>
|
||||
vdb
|
||||
releases
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
<PYPI_NAME>[doc]
|
||||
vyper-debug[doc]
|
||||
|
|
|
|||
8
setup.py
8
setup.py
|
|
@ -36,14 +36,14 @@ extras_require['dev'] = (
|
|||
)
|
||||
|
||||
setup(
|
||||
name='<PYPI_NAME>',
|
||||
name='vyper-debug',
|
||||
# *IMPORTANT*: Don't manually change the version here. Use `make bump`, as described in readme
|
||||
version='0.1.0-alpha.0',
|
||||
description="""<PYPI_NAME>: <SHORT_DESCRIPTION>""",
|
||||
description="""vyper-debug: Easy to use Vyper debugger | vdb""",
|
||||
long_description_markdown_filename='README.md',
|
||||
author='Jason Carver',
|
||||
author_email='ethcalibur+pip@gmail.com',
|
||||
url='https://github.com/ethereum/<REPO_NAME>',
|
||||
url='https://github.com/ethereum/vyper-debug',
|
||||
include_package_data=True,
|
||||
install_requires=[
|
||||
"eth-utils>=1,<2",
|
||||
|
|
@ -51,7 +51,7 @@ setup(
|
|||
setup_requires=['setuptools-markdown'],
|
||||
python_requires='>=3.5, <4',
|
||||
extras_require=extras_require,
|
||||
py_modules=['<MODULE_NAME>'],
|
||||
py_modules=['vdb'],
|
||||
license="MIT",
|
||||
zip_safe=False,
|
||||
keywords='ethereum',
|
||||
|
|
|
|||
|
|
@ -1,4 +1,4 @@
|
|||
|
||||
|
||||
def test_import():
|
||||
import <MODULE_NAME> # noqa: F401
|
||||
import vdb # noqa: F401
|
||||
|
|
|
|||
6
tox.ini
6
tox.ini
|
|
@ -9,7 +9,7 @@ combine_as_imports=True
|
|||
force_sort_within_sections=True
|
||||
include_trailing_comma=True
|
||||
known_third_party=hypothesis,pytest
|
||||
known_first_party=<MODULE_NAME>
|
||||
known_first_party=vdb
|
||||
line_length=21
|
||||
multi_line_output=3
|
||||
use_parentheses=True
|
||||
|
|
@ -38,5 +38,5 @@ whitelist_externals=make
|
|||
basepython=python
|
||||
extras=lint
|
||||
commands=
|
||||
flake8 {toxinidir}/<MODULE_NAME> {toxinidir}/tests
|
||||
isort --recursive --check-only --diff {toxinidir}/<MODULE_NAME> {toxinidir}/tests
|
||||
flake8 {toxinidir}/vdb {toxinidir}/tests
|
||||
isort --recursive --check-only --diff {toxinidir}/vdb {toxinidir}/tests
|
||||
|
|
|
|||
Loading…
Reference in New Issue