Make slicker pip-installable

Summary:
This commit makes it so that slicker can be installed as a package!
This required surprisingly many minor changes, in addition to the usual
metadata/boilerplates.

The main change is to the directory structure.  I moved all the code
into `slicker/`, because that's how python wants it.  Then I moved the
tests to a separate directory for consistency.  This required updating
all the imports, because we're now importing e.g. `slicker.khodemod`.
(Actually we use relative imports.)  Due to some quirk I don't
understand, our circular import of `unicode_util` and `khodemod` no
longer works this way, so I switched one to a late-import.

I also removed requirements.txt (it's now `install_requires`).  I kept
the dev-only stuff in a requirements file because I don't really
understand how `setup.py` wants to handle those.  Then I updated the
make rules to match -- `make dev_deps` now installs dev-only
requirements whereas `make install` installs the package itself.

I made the version 0.9; I think we can do 1.0 soon but I want to be a
little clearer about the public API first, and maybe do a few other bits
of housekeeping and cleanup.

Test Plan:
- `make dev_deps install test lint build`
- `slicker main main2` in webapp did something plausibly reasonable

Reviewers: csilvers

Reviewed By: csilvers

Differential Revision: https://phabricator.khanacademy.org/D42146

Author: benjaminjkraft

.gitignore

@@ -0,0 +1,4 @@
+*.pyc
+dist
+build
+slicker.egg-info

Makefile

@@ -1,8 +1,20 @@
-deps:
-	pip install -r requirements.txt
+dev_deps:
+	pip install -r requirements.dev.txt
+
+install:
+	pip install -e .
 
 test:
-	python -m unittest discover
+	python -m unittest discover tests
 
 lint:
 	flake8
+
+build: dev_deps
+	python setup.py sdist        # builds source distribution
+	python setup.py bdist_wheel  # builds wheel
+
+release: build
+	twine upload dist/*
+
+.PHONY: deps test lint build release

README.md

@@ -8,12 +8,7 @@ doing just that!
 
 ## Installation
 
-- `git clone [email protected]:Khan/slicker.git`
-- `git submodule update --init`
-- `pip install -r requirements.txt`
-- optionally, add `slicker.py` to your path
-
-TODO(benkraft): Make slicker pip installable.
+`pip install slicker`
 
 ## Usage
 

requirements.dev.txt

@@ -0,0 +1,2 @@
+flake8
+twine

requirements.txt

@@ -0,0 +1,24 @@
+#!/usr/bin/env python
+
+from setuptools import setup
+
+setup(
+    name='slicker',
+    version='0.9',
+    description='A tool for moving python files.',
+    author='Khan Academy',
+    author_email='[email protected]',
+    url='https://github.com/Khan/slicker',
+    keywords=['codemod', 'refactor', 'refactoring'],
+    packages=['slicker'],
+    install_requires=['asttokens==1.1.8', 'tqdm==4.19.5', 'fix-includes==0.2'],
+    entry_points={
+        # setuptools magic to make a `slicker` binary
+        'console_scripts': ['slicker = slicker.slicker:main'],
+    },
+    classifiers=[
+        'License :: OSI Approved :: MIT License',
+        'Programming Language :: Python :: 2',
+        'Programming Language :: Python :: 2.7',
+    ],
+)

setup.py

@@ -25,8 +25,8 @@
 
 import os
 
-import khodemod
-import util
+from . import khodemod
+from . import util
 
 
 def _expand_and_normalize_one(project_root, old_fullname, new_fullname,

slicker/__init__.py

@@ -40,8 +40,6 @@
 
 import tqdm
 
-import unicode_util
-
 
 DEFAULT_EXCLUDE_PATHS = ('genfiles', 'third_party')
 DEFAULT_EXTENSIONS = ('py',)
@@ -185,6 +183,7 @@ def read_file(root, filename):
     # TODO(benkraft): Cache contents.
     try:
         with open(os.path.join(root, filename)) as f:
+            from . import unicode_util
             return unicode_util.decode(filename, f.read())
     except IOError as e:
         if e.errno == 2:    # No such file
@@ -321,6 +320,7 @@ def write_file(self, root, filename, text, file_permissions=None):
                 # We changed what files exist: clear the cache.
                 _RESOLVE_PATHS_CACHE.clear()
             with open(abspath, 'w') as f:
+                from . import unicode_util
                 f.write(unicode_util.encode(filename, text))
                 self._modified_files.add((root, filename))
             if file_permissions:

inputs.py slicker/inputs.py

@@ -5,8 +5,8 @@
 import os
 import stat
 
-import khodemod
-import util
+from . import khodemod
+from . import util
 
 
 def _add_init_py(filename):

khodemod.py slicker/khodemod.py

@@ -83,10 +83,10 @@
 
 from fix_includes import fix_python_imports
 
-import inputs
-import khodemod
-import moves
-import util
+from . import inputs
+from . import khodemod
+from . import moves
+from . import util
 
 
 _FILENAME_EXTENSIONS = ('.py', '.js', '.jsx', '.png', '.jpg', '.svg', '.html',
@@ -1716,4 +1716,6 @@ def main():
 
 
 if __name__ == '__main__':
+    # Note that pip-installed slicker calls main() directly, rather than
+    # running this file as a script; this is just included for completeness.
     main()

moves.py slicker/moves.py

@@ -19,7 +19,7 @@
 
 import re
 
-import khodemod
+from . import khodemod
 
 
 # From PEP 263: https://www.python.org/dev/peps/pep-0263/

slicker.py slicker/slicker.py

@@ -6,8 +6,8 @@
 
 import asttokens
 
-import khodemod
-import unicode_util
+from . import khodemod
+from . import unicode_util
 
 
 def filename_for_module_name(module_name):

unicode_util.py slicker/unicode_util.py

@@ -2,7 +2,7 @@
 
 import unittest
 
-import inputs
+from slicker import inputs
 import test_slicker
 
 

util.py slicker/util.py

@@ -1,6 +1,6 @@
 from __future__ import absolute_import
 
-import khodemod
+from slicker import khodemod
 import test_slicker
 
 

test_inputs.py tests/test_inputs.py

@@ -3,7 +3,7 @@
 import os
 import stat
 
-import slicker
+from slicker import slicker
 import test_slicker
 
 

test_khodemod.py tests/test_khodemod.py

@@ -6,9 +6,9 @@
 import tempfile
 import unittest
 
-import khodemod
-import slicker
-import util
+from slicker import khodemod
+from slicker import slicker
+from slicker import util
 
 
 class TestBase(unittest.TestCase):