diff --git a/.project-template/template_vars.txt b/.project-template/template_vars.txt index 5beeccb..f5d9a8a 100644 --- a/.project-template/template_vars.txt +++ b/.project-template/template_vars.txt @@ -1,6 +1,6 @@ - - - - - - +vdb +vyper-debug +vyper-debug +vyper-debug +vyper-debug +Easy to use Vyper debugger | vdb diff --git a/Makefile b/Makefile index 18f7003..6b3f310 100644 --- a/Makefile +++ b/Makefile @@ -27,7 +27,7 @@ lint: tox -elint lint-roll: - isort --recursive tests + isort --recursive vdb tests $(MAKE) lint test: diff --git a/README.md b/README.md index 937344d..60eded5 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,25 @@ -# +# vyper-debug -[![Join the chat at https://gitter.im/ethereum/](https://badges.gitter.im/ethereum/.svg)](https://gitter.im/ethereum/?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -[![Build Status](https://circleci.com/gh/ethereum/.svg?style=shield)](https://circleci.com/gh/ethereum/) -[![PyPI version](https://badge.fury.io/py/.svg)](https://badge.fury.io/py/) -[![Python versions](https://img.shields.io/pypi/pyversions/.svg)](https://pypi.python.org/pypi/) -[![Docs build](https://readthedocs.org/projects//badge/?version=latest)](http://.readthedocs.io/en/latest/?badge=latest) +[![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/vyper-debug.svg?style=shield)](https://circleci.com/gh/ethereum/vyper-debug) +[![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/vyper-debug.svg)](https://pypi.python.org/pypi/vyper-debug) +[![Docs build](https://readthedocs.org/projects/vyper-debug/badge/?version=latest)](http://vyper-debug.readthedocs.io/en/latest/?badge=latest) - +Easy to use Vyper debugger | vdb -Read more in the [documentation on ReadTheDocs](https://.readthedocs.io/). [View the change log](https://.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 +pip install vyper-debug ``` ## Developer Setup -If you would like to hack on , 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/.git -cd +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 / tests/ -c "clear; flake8 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 failed'" ../tests ../ +ptw --onfail "notify-send -t 5000 'Test failure ⚠⚠⚠⚠⚠' 'python 3 test on vyper-debug failed'" ../tests ../vdb ``` ### Release setup diff --git a/docs/conf.py b/docs/conf.py index a74a977..84a2d43 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- # -# 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 = '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 = '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', '.tex', ' 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', '', ' 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', '', ' Documentation', - 'Jason Carver', '', '', + ('index', 'vyper-debug', 'vyper-debug Documentation', + 'Jason Carver', 'vyper-debug', 'Easy to use Vyper debugger | vdb', 'Miscellaneous'), ] diff --git a/docs/index.rst b/docs/index.rst index b3598a4..a1a4655 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,7 @@ - +vyper-debug ============================== - +Easy to use Vyper debugger | vdb Contents -------- @@ -9,7 +9,7 @@ Contents .. toctree:: :maxdepth: 3 - + vdb releases diff --git a/requirements-docs.txt b/requirements-docs.txt index 1b49b74..d4bee1c 100644 --- a/requirements-docs.txt +++ b/requirements-docs.txt @@ -1 +1 @@ -[doc] +vyper-debug[doc] diff --git a/setup.py b/setup.py index 99618aa..cfc1502 100644 --- a/setup.py +++ b/setup.py @@ -36,14 +36,14 @@ extras_require['dev'] = ( ) setup( - 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=""": """, + 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/', + 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=[''], + py_modules=['vdb'], license="MIT", zip_safe=False, keywords='ethereum', diff --git a/tests/core/test_import.py b/tests/core/test_import.py index f146ae7..2255b33 100644 --- a/tests/core/test_import.py +++ b/tests/core/test_import.py @@ -1,4 +1,4 @@ def test_import(): - import # noqa: F401 + import vdb # noqa: F401 diff --git a/tox.ini b/tox.ini index 6ae707b..33172c8 100644 --- a/tox.ini +++ b/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= +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}/ {toxinidir}/tests - isort --recursive --check-only --diff {toxinidir}/ {toxinidir}/tests + flake8 {toxinidir}/vdb {toxinidir}/tests + isort --recursive --check-only --diff {toxinidir}/vdb {toxinidir}/tests