status-im/vyper-debug
2
0
Fork 0
mirror of https://github.com/status-im/vyper-debug.git synced 2025-02-18 21:36:30 +00:00
Code Issues Projects Releases Wiki Activity

Initial commit.

Browse Source
This commit is contained in:
Jacques Wagener 2018-07-12 16:34:31 +02:00
parent 56e4b20080
commit fd5df89d62
No known key found for this signature in database
GPG Key ID: C294D1025DA0E923
9 changed files with 40 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
.project-template/template_vars.txt
View File

@ -1,6 +1,6 @@
<MODULE_NAME> vdb
<PYPI_NAME> vyper-debug
<REPO_NAME> vyper-debug
<RTD_NAME> vyper-debug
<PROJECT_NAME> vyper-debug
<SHORT_DESCRIPTION> Easy to use Vyper debugger | vdb

2
Makefile
View File

@ -27,7 +27,7 @@ lint:
tox -elint tox -elint
lint-roll: lint-roll:
isort --recursive <MODULE_NAME> tests isort --recursive vdb tests
$(MAKE) lint $(MAKE) lint
test: test:

28
README.md
View File

@ -1,25 +1,25 @@
# <PROJECT_NAME> # vyper-debug
[![Join the chat at https://gitter.im/ethereum/<REPO_NAME>](https://badges.gitter.im/ethereum/<REPO_NAME>.svg)](https://gitter.im/ethereum/<REPO_NAME>?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Join the chat at https://gitter.im/ethereum/vyper-debug](https://badges.gitter.im/ethereum/vyper-debug.svg)](https://gitter.im/ethereum/vyper-debug?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[![Build Status](https://circleci.com/gh/ethereum/<REPO_NAME>.svg?style=shield)](https://circleci.com/gh/ethereum/<REPO_NAME>) [![Build Status](https://circleci.com/gh/ethereum/vyper-debug.svg?style=shield)](https://circleci.com/gh/ethereum/vyper-debug)
[![PyPI version](https://badge.fury.io/py/<PYPI_NAME>.svg)](https://badge.fury.io/py/<PYPI_NAME>) [![PyPI version](https://badge.fury.io/py/vyper-debug.svg)](https://badge.fury.io/py/vyper-debug)
[![Python versions](https://img.shields.io/pypi/pyversions/<PYPI_NAME>.svg)](https://pypi.python.org/pypi/<PYPI_NAME>) [![Python versions](https://img.shields.io/pypi/pyversions/vyper-debug.svg)](https://pypi.python.org/pypi/vyper-debug)
[![Docs build](https://readthedocs.org/projects/<RTD_NAME>/badge/?version=latest)](http://<RTD_NAME>.readthedocs.io/en/latest/?badge=latest) [![Docs build](https://readthedocs.org/projects/vyper-debug/badge/?version=latest)](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 ## Quickstart
```sh ```sh
pip install <PYPI_NAME> pip install vyper-debug
``` ```
## Developer Setup ## 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) [Ethereum Development Tactical Manual](https://github.com/pipermerriam/ethereum-dev-tactical-manual)
for information on how we do: for information on how we do:
@ -33,8 +33,8 @@ for information on how we do:
You can set up your dev environment with: You can set up your dev environment with:
```sh ```sh
git clone git@github.com:ethereum/<REPO_NAME>.git git clone git@github.com:ethereum/vyper-debug.git
cd <REPO_NAME> cd vyper-debug
virtualenv -p python3 venv virtualenv -p python3 venv
. venv/bin/activate . venv/bin/activate
pip install -e .[dev] pip install -e .[dev]
@ -48,7 +48,7 @@ Show flake8 errors on file change:
```sh ```sh
# Test flake8 # 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: Run multi-process tests in one command, but without color:
@ -64,7 +64,7 @@ Run in one thread, with color and desktop notifications:
```sh ```sh
cd venv 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 ### Release setup

14
docs/conf.py
View File

@ -1,6 +1,6 @@
# -*- coding: utf-8 -*- # -*- 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. # sphinx-quickstart on Thu Oct 16 20:43:24 2014.
# #
# This file is execfile()d with the current directory set to its # This file is execfile()d with the current directory set to its
@ -53,7 +53,7 @@ source_suffix = '.rst'
master_doc = 'index' master_doc = 'index'
# General information about the project. # General information about the project.
project = '<PROJECT_NAME>' project = 'vyper-debug'
copyright = '2018, Jason Carver, Piper Merriam' copyright = '2018, Jason Carver, Piper Merriam'
__version__ = setup_version __version__ = setup_version
@ -189,7 +189,7 @@ html_static_path = ['_static']
#html_file_suffix = None #html_file_suffix = None
# Output file base name for HTML help builder. # Output file base name for HTML help builder.
htmlhelp_basename = '<MODULE_NAME>doc' htmlhelp_basename = 'vdbdoc'
# -- Options for LaTeX output --------------------------------------------- # -- Options for LaTeX output ---------------------------------------------
@ -209,7 +209,7 @@ latex_elements = {
# (source start file, target name, title, # (source start file, target name, title,
# author, documentclass [howto, manual, or own class]). # author, documentclass [howto, manual, or own class]).
latex_documents = [ latex_documents = [
('index', '<MODULE_NAME>.tex', '<PROJECT_NAME> Documentation', ('index', 'vdb.tex', 'vyper-debug Documentation',
'Jason Carver', 'manual'), 'Jason Carver', 'manual'),
] ]
@ -239,7 +239,7 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
('index', '<MODULE_NAME>', '<PROJECT_NAME> Documentation', ('index', 'vdb', 'vyper-debug Documentation',
['Jason Carver'], 1) ['Jason Carver'], 1)
] ]
@ -253,8 +253,8 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
('index', '<PROJECT_NAME>', '<PROJECT_NAME> Documentation', ('index', 'vyper-debug', 'vyper-debug Documentation',
'Jason Carver', '<PROJECT_NAME>', '<SHORT_DESCRIPTION>', 'Jason Carver', 'vyper-debug', 'Easy to use Vyper debugger | vdb',
'Miscellaneous'), 'Miscellaneous'),
] ]

6
docs/index.rst
View File

@ -1,7 +1,7 @@
<PROJECT_NAME> vyper-debug
============================== ==============================
<SHORT_DESCRIPTION> Easy to use Vyper debugger | vdb
Contents Contents
-------- --------
@ -9,7 +9,7 @@ Contents
.. toctree:: .. toctree::
:maxdepth: 3 :maxdepth: 3
<MODULE_NAME> vdb
releases releases

2
requirements-docs.txt
View File

@ -1 +1 @@
<PYPI_NAME>[doc] vyper-debug[doc]

8
setup.py
View File

@ -36,14 +36,14 @@ extras_require['dev'] = (
) )
setup( setup(
name='<PYPI_NAME>', name='vyper-debug',
# *IMPORTANT*: Don't manually change the version here. Use `make bump`, as described in readme # *IMPORTANT*: Don't manually change the version here. Use `make bump`, as described in readme
version='0.1.0-alpha.0', 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', long_description_markdown_filename='README.md',
author='Jason Carver', author='Jason Carver',
author_email='ethcalibur+pip@gmail.com', author_email='ethcalibur+pip@gmail.com',
url='https://github.com/ethereum/<REPO_NAME>', url='https://github.com/ethereum/vyper-debug',
include_package_data=True, include_package_data=True,
install_requires=[ install_requires=[
"eth-utils>=1,<2", "eth-utils>=1,<2",
@ -51,7 +51,7 @@ setup(
setup_requires=['setuptools-markdown'], setup_requires=['setuptools-markdown'],
python_requires='>=3.5, <4', python_requires='>=3.5, <4',
extras_require=extras_require, extras_require=extras_require,
py_modules=['<MODULE_NAME>'], py_modules=['vdb'],
license="MIT", license="MIT",
zip_safe=False, zip_safe=False,
keywords='ethereum', keywords='ethereum',

2
tests/core/test_import.py
View File

@ -1,4 +1,4 @@
def test_import(): def test_import():
import <MODULE_NAME> # noqa: F401 import vdb # noqa: F401

6
tox.ini
View File

@ -9,7 +9,7 @@ combine_as_imports=True
force_sort_within_sections=True force_sort_within_sections=True
include_trailing_comma=True include_trailing_comma=True
known_third_party=hypothesis,pytest known_third_party=hypothesis,pytest
known_first_party=<MODULE_NAME> known_first_party=vdb
line_length=21 line_length=21
multi_line_output=3 multi_line_output=3
use_parentheses=True use_parentheses=True
@ -38,5 +38,5 @@ whitelist_externals=make
basepython=python basepython=python
extras=lint extras=lint
commands= commands=
flake8 {toxinidir}/<MODULE_NAME> {toxinidir}/tests flake8 {toxinidir}/vdb {toxinidir}/tests
isort --recursive --check-only --diff {toxinidir}/<MODULE_NAME> {toxinidir}/tests isort --recursive --check-only --diff {toxinidir}/vdb {toxinidir}/tests