Ensure naming consistency

Rename:
chat_replay_downloader -> chat_downloader
chat-replay-downloader -> chat-downloader

Author: xenova

.github/ISSUE_TEMPLATE/bug_report.md

@@ -24,7 +24,7 @@ A clear and concise description of what the bug is.
 ### If running from the command line, provide the following:
 1. The command used (including the verbose tag, `-v`):
 ```
-chat_replay_downloader -v URL [OPTIONS]
+chat_downloader -v URL [OPTIONS]
 ```
 2. Output from the above command:
 ```

.travis.yml

@@ -25,5 +25,5 @@ deploy:
     secure: PLEASE_REPLACE_ME
   on:
     tags: true
-    repo: xenova/chat_replay_downloader
+    repo: xenova/chat-downloader
     python: 3.8

CONTRIBUTING.md

@@ -15,7 +15,7 @@ Types of Contributions
 Report Bugs
 ~~~~~~~~~~~
 
-Report bugs at https://github.com/xenova/chat_replay_downloader/issues.
+Report bugs at https://github.com/xenova/chat-downloader/issues.
 
 If you are reporting a bug, please include:
 
@@ -38,14 +38,14 @@ and "help wanted" is open to whoever wants to implement it.
 Write Documentation
 ~~~~~~~~~~~~~~~~~~~
 
-chat-replay-downloader could always use more documentation, whether as part of the
-official chat-replay-downloader docs, in docstrings, or even on the web in blog posts,
+chat-downloader could always use more documentation, whether as part of the
+official chat-downloader docs, in docstrings, or even on the web in blog posts,
 articles, and such.
 
 Submit Feedback
 ~~~~~~~~~~~~~~~
 
-The best way to send feedback is to file an issue at https://github.com/xenova/chat_replay_downloader/issues.
+The best way to send feedback is to file an issue at https://github.com/xenova/chat-downloader/issues.
 
 If you are proposing a feature:
 
@@ -57,17 +57,17 @@ If you are proposing a feature:
 Get Started!
 ------------
 
-Ready to contribute? Here's how to set up `chat_replay_downloader` for local development.
+Ready to contribute? Here's how to set up `chat-downloader` for local development.
 
-1. Fork the `chat_replay_downloader` repo on GitHub.
+1. Fork the `chat-downloader` repo on GitHub.
 2. Clone your fork locally::
 
-    $ git clone [email protected]:your_name_here/chat_replay_downloader.git
+    $ git clone [email protected]:your_name_here/chat-downloader.git
 
 3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
 
-    $ mkvirtualenv chat_replay_downloader
-    $ cd chat_replay_downloader/
+    $ mkvirtualenv chat-downloader
+    $ cd chat-downloader/
     $ python setup.py develop
 
 4. Create a branch for local development::
@@ -79,7 +79,7 @@ Ready to contribute? Here's how to set up `chat_replay_downloader` for local dev
 5. When you're done making changes, check that your changes pass flake8 and the
    tests, including testing other Python versions with tox::
 
-    $ flake8 chat_replay_downloader tests
+    $ flake8 chat-downloader tests
     $ python setup.py test or pytest
     $ tox
 
@@ -103,15 +103,15 @@ Before you submit a pull request, check that it meets these guidelines:
    your new functionality into a function with a docstring, and add the
    feature to the list in README.rst.
 3. The pull request should work for Python 3.5, 3.6, 3.7 and 3.8, and for PyPy. Check
-   https://travis-ci.com/xenova/chat_replay_downloader/pull_requests
+   https://travis-ci.com/xenova/chat-downloader/pull_requests
    and make sure that the tests pass for all supported Python versions.
 
 Tips
 ----
 
 To run a subset of tests::
 
-$ pytest tests.test_chat_replay_downloader
+$ pytest tests.test_chat_downloader
 
 
 Deploying

Makefile

@@ -49,7 +49,7 @@ clean-test: ## remove test and coverage artifacts
 	rm -fr .pytest_cache
 
 lint: ## check style with flake8
-	flake8 chat_replay_downloader tests
+	flake8 chat_downloader tests
 
 test: ## run tests quickly with the default Python
 	pytest
@@ -58,15 +58,15 @@ test-all: ## run tests on every Python version with tox
 	tox
 
 coverage: ## check code coverage quickly with the default Python
-	coverage run --source chat_replay_downloader -m pytest
+	coverage run --source chat_downloader -m pytest
 	coverage report -m
 	coverage html
 	$(BROWSER) htmlcov/index.html
 
 docs: ## generate Sphinx HTML documentation, including API docs
-	rm -f docs/chat_replay_downloader.rst
+	rm -f docs/chat_downloader.rst
 	rm -f docs/modules.rst
-	sphinx-apidoc -o docs/ chat_replay_downloader
+	sphinx-apidoc -o docs/ chat_downloader
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs html
 	$(BROWSER) docs/_build/html/index.html

README.md

@@ -1,72 +1,72 @@
 # Chat Downloader
 A simple tool used to retrieve chat messages from livestreams, videos, clips and past broadcasts. No authentication needed!
 
-[![Python](https://img.shields.io/pypi/pyversions/chat-replay-downloader)](https://pypi.org/project/chat-replay-downloader)
-[![PyPI version](https://img.shields.io/pypi/v/chat-replay-downloader.svg)](https://pypi.org/project/chat-replay-downloader)
-[![PyPI Downloads](https://img.shields.io/pypi/dm/chat-replay-downloader)](https://pypi.org/project/chat-replay-downloader)
-[![GitHub license](https://img.shields.io/github/license/xenova/chat-replay-downloader)](https://github.com/xenova/chat-replay-downloader/blob/master/LICENSE)
+[![Python](https://img.shields.io/pypi/pyversions/chat-downloader)](https://pypi.org/project/chat-downloader)
+[![PyPI version](https://img.shields.io/pypi/v/chat-downloader.svg)](https://pypi.org/project/chat-downloader)
+[![PyPI Downloads](https://img.shields.io/pypi/dm/chat-downloader)](https://pypi.org/project/chat-downloader)
+[![GitHub license](https://img.shields.io/github/license/xenova/chat-downloader)](https://github.com/xenova/chat-downloader/blob/master/LICENSE)
 
 
 
 <!---
-[![GitHub issues](https://img.shields.io/github/issues/xenova/chat-replay-downloader)](https://badge.fury.io/py/chat-replay-downloader)
-[![GitHub forks](https://img.shields.io/github/forks/xenova/chat-replay-downloader)](https://badge.fury.io/py/chat-replay-downloader)
-[![GitHub stars](https://img.shields.io/github/stars/xenova/chat-replay-downloader)](https://badge.fury.io/py/chat-replay-downloader)
-[![Downloads](https://img.shields.io/github/downloads/xenova/chat-replay-downloader/total.svg)](https://github.com/xenova/chat-replay-downloader/releases)
+[![GitHub issues](https://img.shields.io/github/issues/xenova/chat-downloader)](https://badge.fury.io/py/chat-downloader)
+[![GitHub forks](https://img.shields.io/github/forks/xenova/chat-downloader)](https://badge.fury.io/py/chat-downloader)
+[![GitHub stars](https://img.shields.io/github/stars/xenova/chat-downloader)](https://badge.fury.io/py/chat-downloader)
+[![Downloads](https://img.shields.io/github/downloads/xenova/chat-downloader/total.svg)](https://github.com/xenova/chat-downloader/releases)
 -->
 
 ## Installation
 ### Install using `pip`
 ```
-pip install chat-replay-downloader
+pip install chat-downloader
 ```
 
 To update to the latest version, add the `--upgrade` flag to the above command.
 ### Install using `git`
 ```
-git clone https://github.com/xenova/chat-replay-downloader.git
-cd chat-replay-downloader
+git clone https://github.com/xenova/chat-downloader.git
+cd chat-downloader
 python setup.py install
 ```
 
 ## Usage
 
 ### Python:
 ```python
-from chat_replay_downloader import ChatDownloader
+from chat_downloader import ChatDownloader
 
 url = 'https://www.youtube.com/watch?v=5qap5aO4i9A'
 chat = ChatDownloader().get_chat(url)       # create a generator
 for message in chat:                        # iterate over messages
     print(chat.format(message))             # print the formatted message
 ```
-For advanced python use-cases and examples, consult the [Python Wiki](https://github.com/xenova/chat-replay-downloader/wiki/Python-Documentation).
+For advanced python use-cases and examples, consult the [Python Wiki](https://github.com/xenova/chat-downloader/wiki/Python-Documentation).
 
 ### Command line:
 ```
-chat_replay_downloader https://www.youtube.com/watch?v=5qap5aO4i9A
+chat_downloader https://www.youtube.com/watch?v=5qap5aO4i9A
 ```
 
-For advanced command line use-cases and examples, consult the [Command Line Wiki](https://github.com/xenova/chat-replay-downloader/wiki/Command-Line-Usage).
+For advanced command line use-cases and examples, consult the [Command Line Wiki](https://github.com/xenova/chat-downloader/wiki/Command-Line-Usage).
 
 
 ## Issues
-Found a bug or have a suggestion? File an issue [here](https://github.com/xenova/chat-replay-downloader/issues/new). To assist the developers in fixing the issue, please follow the issue template (automatically generated when creating a new issue).
+Found a bug or have a suggestion? File an issue [here](https://github.com/xenova/chat-downloader/issues/new). To assist the developers in fixing the issue, please follow the issue template (automatically generated when creating a new issue).
 
 ## Contributing
 ### Become a contributor
 #### Run as a developer
 To run the program as a developer, you do not need to build anything separately. Simply execute:
 ```
-python -m chat_replay_downloader
+python -m chat_downloader
 ```
 [work in progress]
 
 #### Add support for a new site:
-1. [Fork](https://github.com/xenova/chat-replay-downloader/fork) this repository.
+1. [Fork](https://github.com/xenova/chat-downloader/fork) this repository.
 2. Clone the source code with:
 
-        git clone [email protected]:YOUR_GITHUB_USERNAME/chat-replay-downloader.git
+        git clone [email protected]:YOUR_GITHUB_USERNAME/chat-downloader.git
 3. Start a new branch with:
 
         cd youtube-dl
@@ -79,7 +79,7 @@ Note that this will not affect any output you write to files (using `--output`).
  For example:
 
 ```
-chat_replay_downloader https://www.youtube.com/watch?v=5qap5aO4i9A --testing
+chat_downloader https://www.youtube.com/watch?v=5qap5aO4i9A --testing
 ```
 
 Some extractors use undocumented endpoints and may and as a result, users may encounter items which will not be parsed correctly. Increased testing will improve functionality of the software for other users and is greatly appreciated.
@@ -90,7 +90,7 @@ Chat items are parsed into JSON objects (a.k.a. dictionaries) and follow this te
 
 [work in progress]
 
-For a more in-depth output template, consult the [Item Wiki](https://github.com/xenova/chat-replay-downloader/wiki/Item-Template).
+For a more in-depth output template, consult the [Item Wiki](https://github.com/xenova/chat-downloader/wiki/Item-Template).
 
 ## Supported sites:
 - YouTube.com - Livestreams, past broadcasts and premieres.

chat_downloader/__init__.py

@@ -0,0 +1,9 @@
+"""Top-level package for chat-downloader."""
+
+__author__ = 'Joshua Lochner'
+__email__ = '[email protected]'
+__version__ = '0.0.1'
+__url__ = 'https://github.com/xenova/chat-downloader'
+
+from .cli import main
+from .chat_downloader import ChatDownloader

chat_downloader/__main__.py

@@ -0,0 +1,4 @@
+import chat_downloader
+
+if __name__ == '__main__':
+    chat_downloader.main()

chat_replay_downloader/chat_replay_downloader.py chat_downloader/chat_downloader.py

@@ -1,4 +1,4 @@
-"""Console script for chat_replay_downloader."""
+"""Console script for chat_downloader."""
 import argparse
 import sys
 import os
@@ -10,8 +10,8 @@
 from docstring_parser import parse as doc_parse
 from requests.exceptions import RequestException
 
-import chat_replay_downloader
-from .chat_replay_downloader import ChatDownloader
+import chat_downloader
+from .chat_downloader import ChatDownloader
 from .sites import BaseChatDownloader
 from .output.continuous_write import ContinuousWriter
 
@@ -33,7 +33,7 @@ def main():
         formatter_class=argparse.RawTextHelpFormatter,
     )
 
-    parser.add_argument('--version', action='version', version=chat_replay_downloader.__version__)
+    parser.add_argument('--version', action='version', version=chat_downloader.__version__)
 
     # PROGRAM PARAMS
     parser.add_argument(
@@ -199,7 +199,7 @@ def try_parse_int(text):
     output_file = None
     try:
         log('debug', 'Python version: {}'.format(sys.version))
-        log('debug', 'Program version: {}'.format(chat_replay_downloader.__version__))
+        log('debug', 'Program version: {}'.format(chat_downloader.__version__))
 
         chat = downloader.get_chat(**chat_params)