update gitignore and readme

.gitignore

@@ -1,4 +1,10 @@
-*.py[oc]
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
 
 # Temp files
 *~
@@ -7,17 +13,46 @@
 \#*
 .#*
 *#
-dist
-.DS_Store
 
-# Build files
-build
-dist
-pkg
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
 *.egg
-*.egg-info
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
 
-# Test files
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
 .pytest_cache/
 
 # Debian Files
@@ -30,8 +65,6 @@ doc/_build
 # Generated man page
 doc/aws_hostname.1
 
-.coverage
-.cache
 _run.py
 _devfiles/*
 
@@ -41,9 +74,54 @@ _templates
 _autosummary
 .pytest_cache*
 
-# IDE Files
-.idea/
-#Pycharm stuff
-.idea/*
-
 .vscode/
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+
+# Mac
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon?
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+.dropbox
+
+# Generated
+test/**/*.xml
+/*.gv
+/*.dot
+/*.xml
+
+# PyCharm
+.idea/workspace.xml
+.idea/usage.statistics.xml
+.idea/tasks.xml
+.idea/modules.xml
+.idea/*.iml

.idea/inspectionProfiles/profiles_settings.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <settings>
+    <option name="USE_PROJECT_PROFILE" value="false" />
+    <version value="1.0" />
+  </settings>
+</component>

.idea/misc.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" project-jdk-name="Python 3.7" project-jdk-type="Python SDK" />
+</project>

.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

README.md

@@ -1,15 +1,15 @@
 
 <div align="center">
   <p>
-  <img src="https://github.com/nficano/pytube/blob/master/images/pytube.png?raw=true" width="350" height="328" alt="pytube logo" />
+  <img src="https://github.com/hbmartin/pytube3/blob/master/images/pytube.png?raw=true" width="350" height="328" alt="pytube logo" />
   </p>
   <p align="center">
-	  <img src="https://img.shields.io/pypi/v/pytube.svg" alt="pypi">
-	  <a href="https://travis-ci.org/nficano/pytube"><img src="https://travis-ci.org/nficano/pytube.svg?branch=master" /></a>
+	  <img src="https://img.shields.io/pypi/v/pytube3.svg" alt="pypi">
+	  <a href="https://travis-ci.org/hbmartin/pytube3"><img src="https://travis-ci.org/hbmartin/pytube3.svg?branch=master" /></a>
 	  <a href="http://python-pytube.readthedocs.io/en/latest/?badge=latest"><img src="https://readthedocs.org/projects/python-pytube/badge/?version=latest" /></a>
-	  <a href="https://coveralls.io/github/nficano/pytube?branch=master"><img src="https://coveralls.io/repos/github/nficano/pytube/badge.svg?branch=master#23e6f7ac56dd3bde" /></a>
-      <a href="https://pypi.org/project/pytube/"><img src="https://img.shields.io/pypi/dm/pytube.svg" alt="pypi"></a>
-	  <a href="https://pypi.python.org/pypi/pytube/"><img src="https://img.shields.io/pypi/pyversions/pytube.svg" /></a>
+	  <a href="https://coveralls.io/github/hbmartin/pytube3?branch=master"><img src="https://coveralls.io/repos/github/hbmartin/pytube3/badge.svg?branch=master" /></a>
+	  <a href="https://pypi.python.org/pypi/pytube3/"><img src="https://img.shields.io/pypi/pyversions/pytube3.svg" /></a>
+	  <a href="https://github.com/ambv/black"><img src="https://img.shields.io/badge/code%20style-black-000000.svg" /></a>
   </p>
 </div>
 
@@ -54,8 +54,9 @@ Finally *pytube* also includes a command-line utility, allowing you to quickly d
 Download using pip via pypi.
 
 ```bash
-$ pip install pytube
+$ pip install pytube3 --upgrade
 ```
+Mac/homebrew users may need to use ``pip3``
 
 ## Getting started
 
@@ -232,3 +233,11 @@ $ pytube http://youtube.com/watch?v=9bZkp7q19f0 --list
 ```
 
 Finally, if you're filing a bug report, the cli contains a switch called ``--build-playback-report``, which bundles up the state, allowing others to easily replay your issue.
+
+## Contributing
+
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
+
+### Code Formatting
+
+This project is linted with [pyflakes](https://github.com/PyCQA/pyflakes) and makes strict use of [Black](https://github.com/ambv/black) for code formatting.

setup.py

@@ -81,7 +81,7 @@ setup(
         'Topic :: Terminals',
         'Topic :: Utilities',
     ],
-    description=('A pythonic library for downloading YouTube Videos.'),
+    description=('Python 3 library for downloading YouTube Videos.'),
     include_package_data=True,
     long_description_content_type='text/markdown',
     long_description=long_description,