Fill in template variables

.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/<REPO_NAME>/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://<RTD_NAME>.readthedocs.io/en/latest/contributing.html#pull-requests)
+[//]: # (See: https://py-libp2p.readthedocs.io/en/latest/contributing.html#pull-requests)
-- [ ] Add entry to the [release notes](https://github.com/ethereum/<REPO_NAME>/blob/master/newsfragments/README.md)
+- [ ] Add entry to the [release notes](https://github.com/libp2p/py-libp2p/blob/master/newsfragments/README.md)
 
 #### Cute Animal Picture
 

.project-template/template_vars.txt

@@ -1,6 +1,6 @@
-<MODULE_NAME>
+libp2p
-<PYPI_NAME>
+libp2p
-<REPO_NAME>
+py-libp2p
-<RTD_NAME>
+py-libp2p
-<PROJECT_NAME>
+py-libp2p
-<SHORT_DESCRIPTION>
+The Python implementation of the libp2p networking stack

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/<PYPI_NAME>.svg)](https://badge.fury.io/py/<PYPI_NAME>)
+[![PyPI version](https://badge.fury.io/py/libp2p.svg)](https://badge.fury.io/py/libp2p)
-[![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/libp2p.svg)](https://pypi.python.org/pypi/libp2p)
-[![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/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.
 
-<SHORT_DESCRIPTION>
+The Python implementation of the libp2p networking stack
 
-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://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/<REPO_NAME>.git
+git clone git@github.com:libp2p/py-libp2p.git
-cd <REPO_NAME>
+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 <MODULE_NAME>/ tests/ -c "clear; flake8 <MODULE_NAME> 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 <REPO_NAME> failed'" ../tests ../<MODULE_NAME>
+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.

docs/conf.py

@@ -1,6 +1,6 @@
 # -*- coding: utf-8 -*-
 #
-# <PROJECT_NAME> 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_NAME>'
+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 = '<MODULE_NAME>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', '<MODULE_NAME>.tex', '<PROJECT_NAME> 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', '<MODULE_NAME>', '<PROJECT_NAME> 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', '<PROJECT_NAME>', '<PROJECT_NAME> Documentation',
+  ('index', 'py-libp2p', 'py-libp2p Documentation',
-   'The Ethereum Foundation', '<PROJECT_NAME>', '<SHORT_DESCRIPTION>',
+   'The Ethereum Foundation', 'py-libp2p', 'The Python implementation of the libp2p networking stack',
    'Miscellaneous'),
 ]
 

docs/index.rst

@@ -1,7 +1,7 @@
-<PROJECT_NAME>
+py-libp2p
 ==============================
 
-<SHORT_DESCRIPTION>
+The Python implementation of the libp2p networking stack
 
 Contents
 --------
@@ -9,7 +9,7 @@ Contents
 .. toctree::
     :maxdepth: 3
 
-    <MODULE_NAME>
+    libp2p
     release_notes
 
 

pyproject.toml

@@ -1,10 +1,10 @@
 [tool.towncrier]
-# Read https://github.com/ethereum/<REPO_NAME>/newsfragments/README.md for instructions
+# Read https://github.com/libp2p/py-libp2p/newsfragments/README.md for instructions
-package = "<MODULE_NAME>"
+package = "libp2p"
 filename = "docs/release_notes.rst"
 directory = "newsfragments"
 underlines = ["-", "~", "^"]
-issue_format = "`#{issue} <https://github.com/ethereum/<REPO_NAME>/issues/{issue}>`__"
+issue_format = "`#{issue} <https://github.com/libp2p/py-libp2p/issues/{issue}>`__"
 
 [[tool.towncrier.type]]
 directory = "feature"
@@ -33,7 +33,7 @@ showcontent = true
 
 [[tool.towncrier.type]]
 directory = "internal"
-name = "Internal Changes - for <PROJECT_NAME> Contributors"
+name = "Internal Changes - for py-libp2p Contributors"
 showcontent = true
 
 [[tool.towncrier.type]]

requirements-docs.txt

@@ -1 +1 @@
-<PYPI_NAME>[doc]
+libp2p[doc]

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=["<MODULE_NAME>"],
+    py_modules=["libp2p"],
     license="MIT/APACHE2.0",
     zip_safe=False,
     keywords="libp2p p2p",

tests/core/test_import.py

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

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=<MODULE_NAME>
+known_first_party=libp2p
 line_length=88
 multi_line_output=3
 use_parentheses=True