From d589daf00d1931018f74b4842a5eecbcce33230d Mon Sep 17 00:00:00 2001 From: Jason Carver Date: Tue, 26 Nov 2019 12:44:17 -0800 Subject: [PATCH] Fill in template variables --- .github/PULL_REQUEST_TEMPLATE.md | 6 +++--- .project-template/template_vars.txt | 12 ++++++------ README.md | 18 +++++++++--------- docs/conf.py | 14 +++++++------- docs/index.rst | 6 +++--- pyproject.toml | 8 ++++---- requirements-docs.txt | 2 +- setup.py | 4 ++-- tests/core/test_import.py | 2 +- tox.ini | 2 +- 10 files changed, 37 insertions(+), 37 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 21d4db5..4ef27e5 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -11,10 +11,10 @@ Summary of approach. [//]: # (Stay ahead of things, add list items here!) - [ ] Clean up commit history -[//]: # (For important changes that should go into the release notes please add a newsfragment file as explained here: https://github.com/ethereum//blob/master/newsfragments/README.md) +[//]: # (For important changes that should go into the release notes please add a newsfragment file as explained here: https://github.com/libp2p/py-libp2p/blob/master/newsfragments/README.md) -[//]: # (See: https://.readthedocs.io/en/latest/contributing.html#pull-requests) -- [ ] Add entry to the [release notes](https://github.com/ethereum//blob/master/newsfragments/README.md) +[//]: # (See: https://py-libp2p.readthedocs.io/en/latest/contributing.html#pull-requests) +- [ ] Add entry to the [release notes](https://github.com/libp2p/py-libp2p/blob/master/newsfragments/README.md) #### Cute Animal Picture diff --git a/.project-template/template_vars.txt b/.project-template/template_vars.txt index 5beeccb..ce0a492 100644 --- a/.project-template/template_vars.txt +++ b/.project-template/template_vars.txt @@ -1,6 +1,6 @@ - - - - - - +libp2p +libp2p +py-libp2p +py-libp2p +py-libp2p +The Python implementation of the libp2p networking stack diff --git a/README.md b/README.md index f194360..a375890 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ [![Join the chat at https://gitter.im/py-libp2p/Lobby](https://badges.gitter.im/py-libp2p/Lobby.png)](https://gitter.im/py-libp2p/Lobby) [![Build Status](https://travis-ci.com/libp2p/py-libp2p.svg?branch=master)](https://travis-ci.com/libp2p/py-libp2p) -[![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) +[![PyPI version](https://badge.fury.io/py/libp2p.svg)](https://badge.fury.io/py/libp2p) +[![Python versions](https://img.shields.io/pypi/pyversions/libp2p.svg)](https://pypi.python.org/pypi/libp2p) +[![Docs build](https://readthedocs.org/projects/py-libp2p/badge/?version=latest)](http://py-libp2p.readthedocs.io/en/latest/?badge=latest) [![Freenode](https://img.shields.io/badge/freenode-%23libp2p-yellow.svg)](https://webchat.freenode.net/?channels=%23libp2p) [![Matrix](https://img.shields.io/badge/matrix-%23libp2p%3Apermaweb.io-blue.svg)](https://riot.permaweb.io/#/room/#libp2p:permaweb.io) [![Discord](https://img.shields.io/discord/475789330380488707?color=blueviolet&label=discord)](https://discord.gg/66KBrm2) @@ -18,9 +18,9 @@ ## WARNING py-libp2p is an experimental and work-in-progress repo under heavy development. We do not yet recommend using py-libp2p in production environments. - +The Python implementation of the libp2p networking stack -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://py-libp2p.readthedocs.io/). [View the change log](https://py-libp2p.readthedocs.io/en/latest/releases.html). ## Sponsorship This project is graciously sponsored by the Ethereum Foundation through [Wave 5 of their Grants Program](https://blog.ethereum.org/2019/02/21/ethereum-foundation-grants-program-wave-5/). @@ -35,8 +35,8 @@ The py-libp2p team consists of: py-libp2p requires Python 3.7 and the best way to guarantee a clean Python 3.7 environment is with [`virtualenv`](https://virtualenv.pypa.io/en/stable/) ```sh -git clone git@github.com:ethereum/.git -cd +git clone git@github.com:libp2p/py-libp2p.git +cd py-libp2p virtualenv -p python3.7 venv . venv/bin/activate pip install -e .[dev] @@ -50,7 +50,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 libp2p/ tests/ -c "clear; flake8 libp2p tests && echo 'flake8 success' || echo 'error'" ``` Run multi-process tests in one command, but without color: @@ -66,7 +66,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 py-libp2p failed'" ../tests ../libp2p ``` Note that tests/libp2p/test_libp2p.py contains an end-to-end messaging test between two libp2p hosts, which is the bulk of our proof of concept. diff --git a/docs/conf.py b/docs/conf.py index aaf6fb6..54b210a 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -1,6 +1,6 @@ # -*- coding: utf-8 -*- # -# documentation build configuration file, created by +# py-libp2p 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 = 'py-libp2p' copyright = '2019, The Ethereum Foundation' __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 = 'libp2pdoc' # -- 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', 'libp2p.tex', 'py-libp2p Documentation', 'The Ethereum Foundation', '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', 'libp2p', 'py-libp2p Documentation', ['The Ethereum Foundation'], 1) ] @@ -253,8 +253,8 @@ man_pages = [ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', '', ' Documentation', - 'The Ethereum Foundation', '', '', + ('index', 'py-libp2p', 'py-libp2p Documentation', + 'The Ethereum Foundation', 'py-libp2p', 'The Python implementation of the libp2p networking stack', 'Miscellaneous'), ] diff --git a/docs/index.rst b/docs/index.rst index 89815ef..8fa151f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,7 +1,7 @@ - +py-libp2p ============================== - +The Python implementation of the libp2p networking stack Contents -------- @@ -9,7 +9,7 @@ Contents .. toctree:: :maxdepth: 3 - + libp2p release_notes diff --git a/pyproject.toml b/pyproject.toml index aaf9dd9..ba94a6c 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,10 +1,10 @@ [tool.towncrier] -# Read https://github.com/ethereum//newsfragments/README.md for instructions -package = "" +# Read https://github.com/libp2p/py-libp2p/newsfragments/README.md for instructions +package = "libp2p" filename = "docs/release_notes.rst" directory = "newsfragments" underlines = ["-", "~", "^"] -issue_format = "`#{issue} /issues/{issue}>`__" +issue_format = "`#{issue} `__" [[tool.towncrier.type]] directory = "feature" @@ -33,7 +33,7 @@ showcontent = true [[tool.towncrier.type]] directory = "internal" -name = "Internal Changes - for Contributors" +name = "Internal Changes - for py-libp2p Contributors" showcontent = true [[tool.towncrier.type]] diff --git a/requirements-docs.txt b/requirements-docs.txt index 1b49b74..ba1ee49 100644 --- a/requirements-docs.txt +++ b/requirements-docs.txt @@ -1 +1 @@ -[doc] +libp2p[doc] diff --git a/setup.py b/setup.py index c0b6f35..3782231 100644 --- a/setup.py +++ b/setup.py @@ -55,7 +55,7 @@ setup( long_description_content_type="text/markdown", maintainer="The Ethereum Foundation", maintainer_email="snakecharmers@ethereum.org", - url="https://github.com/ethereum/py-libp2p", + url="https://github.com/libp2p/py-libp2p", include_package_data=True, install_requires=[ "pycryptodome>=3.9.2,<4.0.0", @@ -71,7 +71,7 @@ setup( ], python_requires=">=3.7,<4", extras_require=extras_require, - py_modules=[""], + py_modules=["libp2p"], license="MIT/APACHE2.0", zip_safe=False, keywords="libp2p p2p", diff --git a/tests/core/test_import.py b/tests/core/test_import.py index 07b2a18..325444f 100644 --- a/tests/core/test_import.py +++ b/tests/core/test_import.py @@ -1,2 +1,2 @@ def test_import(): - import # noqa: F401 + import libp2p # noqa: F401 diff --git a/tox.ini b/tox.ini index ce0fbe0..de4f8f1 100644 --- a/tox.ini +++ b/tox.ini @@ -13,7 +13,7 @@ combine_as_imports=False force_sort_within_sections=True include_trailing_comma=True known_third_party=hypothesis,pytest,p2pclient,pexpect,factory -known_first_party= +known_first_party=libp2p line_length=88 multi_line_output=3 use_parentheses=True