pip-installable package

.bumpversion.cfg

@@ -0,0 +1,13 @@
+[bumpversion]
+current_version = 0.1.8
+commit = True
+tag = True
+
+[bumpversion:file:grumpy-tools-src/setup.py]
+
+[bumpversion:file:grumpy-tools-src/grumpy_tools/__init__.py]
+
+[bumpversion:file:grumpy-runtime-src/setup.py]
+
+[bumpversion:file:grumpy-runtime-src/grumpy_runtime/__init__.py]
+

.gitignore

@@ -2,3 +2,17 @@ build
 errors.err
 *.swp
 *.pyc
+*.egg
+.eggs/
+
+grumpy-tools-src/dist/
+grumpy-tools-src/*.egg-info
+grumpy-runtime-src/dist
+grumpy-runtime-src/*.egg-info
+
+# Cache
+.pytest_cache/
+
+# Editors
+.vscode/
+

.travis.yml

@@ -1,11 +1,31 @@
 language: go
+go:
+  - "1.10.x"
+
 os:
   - linux
   - osx
 before_script:
-  - rvm get head || true # https://github.com/travis-ci/travis-ci/issues/6307 
-  - set -e
+  - python -c "import fcntl; fcntl.fcntl(1, fcntl.F_SETFL, 0)"  # https://github.com/travis-ci/travis-ci/issues/8920#issuecomment-352661024
 # Run gofmt and lint serially to avoid confusing output. Run tests in parallel
 # for speed.
-script: make gofmt lint && make -j2 test
-after_script: set +e
+  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then sudo pip2 install pytest ; fi
+  - if [[ "$TRAVIS_OS_NAME" != "osx" ]]; then pip2 install pytest --user ; fi
+script:
+  # Install the thing
+  - cd grumpy-tools-src
+  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then sudo pip2 install . ; fi
+  - if [[ "$TRAVIS_OS_NAME" != "osx" ]]; then pip2 install . --user ; fi
+  - which grumpy
+  - cd ../grumpy-runtime-src
+  - if [[ "$TRAVIS_OS_NAME" == "osx" ]]; then sudo pip2 install . ; fi
+  - if [[ "$TRAVIS_OS_NAME" != "osx" ]]; then pip2 install . --user ; fi
+  # Test the thing
+  - cd ../grumpy-tools-src
+  - pytest
+  - cd ../grumpy-runtime-src
+  - make gofmt lint && make -j2 test
+
+# OSX swallows error logs: https://github.com/travis-ci/travis-ci/issues/6018
+after_error:
+  - echo "== End of test log ==""

README.md

@@ -1,6 +1,6 @@
 # Grumpy: Go running Python
 
-[![Build Status](https://travis-ci.org/google/grumpy.svg?branch=master)](https://travis-ci.org/google/grumpy)
+[![Build Status](https://travis-ci.org/alanjds/grumpy.svg?branch=master)](https://travis-ci.org/alanjds/grumpy)
 [![Join the chat at https://gitter.im/grumpy-devel/Lobby](https://badges.gitter.im/grumpy-devel/Lobby.svg)](https://gitter.im/grumpy-devel/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 ## Overview
@@ -56,14 +56,34 @@ There are three basic categories of incomplete functionality:
 
 ## Running Grumpy Programs
 
+### Pre-requisites
+
+The commands ahead assumes that you have Golang installed and a recent
+version of Python 2, `setuptools` and `pip`.
+
+### Method 1: binary package
+
+For convenience, a Python package is provided from the PyPI. During install,
+many Grumpy will be compiled and stored inside your Python installation.
+
+You need Golang preinstalled anyway for the installation to be successful.
+
+```
+pip2 install -U grumpy-runtime -I --no-cache
+(wait about 5 minutes)
+echo "print 'hello, world'" | grumpy run
+```
+
 ### Method 1: make run:
 
 The simplest way to execute a Grumpy program is to use `make run`, which wraps a
 shell script called grumprun that takes Python code on stdin and builds and runs
-the code under Grumpy. All of the commands below are assumed to be run from the
-root directory of the Grumpy source code distribution:
+the code under Grumpy:
 
 ```
+cd grumpy-tools-src
+python2 setup.py develop
+cd ../grumpy-runtime-src
 echo "print 'hello, world'" | make run
 ```
 
@@ -81,6 +101,9 @@ The first step is to set up the shell so that the Grumpy toolchain and libraries
 can be found. From the root directory of the Grumpy source distribution run:
 
 ```
+cd grumpy-tools-src
+python2 setup.py develop
+cd ../grumpy-runtime-src
 make
 export PATH=$PWD/build/bin:$PATH
 export GOPATH=$PWD/build
@@ -91,18 +114,21 @@ You will know things are working if you see the expected output from this
 command:
 
 ```
+cd grumpy-runtime-src
 echo 'import sys; print sys.version' | grumprun
 ```
 
 Next, we will write our simple Python module into the \_\_python\_\_ directory:
 
 ```
+cd grumpy-runtime-src
 echo 'def hello(): print "hello, world"' > $GOPATH/src/__python__/hello.py
 ```
 
 To build a Go package from our Python script, run the following:
 
 ```
+cd grumpy-runtime-src
 mkdir -p $GOPATH/src/__python__/hello
 grumpc -modname=hello $GOPATH/src/__python__/hello.py > \
     $GOPATH/src/__python__/hello/module.go
@@ -113,6 +139,7 @@ You should now be able to build a Go program that imports the package
 that are built using grumprun:
 
 ```
+cd grumpy-runtime-src
 echo 'from hello import hello; hello()' | grumprun
 ```
 
@@ -129,48 +156,50 @@ grumprun is doing a few things under the hood here:
 There are three main components and depending on what kind of feature you're
 writing, you may need to change one or more of these.
 
-### grumpc
+### Grumpy Tools
 
-Grumpy converts Python programs into Go programs and `grumpc` is the tool
-responsible for parsing Python code and generating Go code from it. `grumpc` is
-written in Python and uses the [`pythonparser`](https://github.com/m-labs/pythonparser)
+Grumpy converts Python programs into Go programs and
+`grumpy transpile` is the CLI tool responsible for parsing Python code
+and generating Go code from it. `grumpy transpile` is written in Python
+and uses the [`pythonparser`](https://github.com/m-labs/pythonparser)
 module to accomplish parsing.
 
-The grumpc script itself lives at `tools/grumpc`. It is supported by a number of
-Python modules in the `compiler` subdir.
+The CLI main entrypoint lives at `grumpy-tools-src/grumpy_tools/cli.py`.
+It is supported by a number of Python modules in the
+`grumpy-tools-src/grumpy_tools/compiler` subdir.
 
 ### Grumpy Runtime
 
-The Go code generated by `grumpc` performs operations on data structures that
-represent Python objects in running Grumpy programs. These data structures and
-operations are defined in the `grumpy` Go library (source is in the runtime
-subdir of the source distribution).  This runtime is analogous to the Python C
-API and many of the structures and operations defined by `grumpy` have
-counterparts in CPython.
+The Go code generated by `grumpy transpile` performs operations
+on data structures that represent Python objects in running Grumpy programs.
+These data structures and operations are defined in the `grumpy` Go library
+(source is in the `grumpy-runtime-src/runtime` subdir of the source
+distribution). This runtime is analogous to the Python C API and many of the
+structures and operations defined by `grumpy` have counterparts in CPython.
 
 ### Grumpy Standard Library
 
 Much of the Python standard library is written in Python and thus "just works"
 in Grumpy. These parts of the standard library are copied from CPython 2.7
 (possibly with light modifications). For licensing reasons, these files are kept
-in the `third_party` subdir.
+in the `grumpy-runtime-src/third_party` subdir.
 
 The parts of the standard library that cannot be written in pure Python, e.g.
-file and directory operations, are kept in the `lib` subdir. In CPython these
-kinds of modules are written as C extensions. In Grumpy they are written in
-Python but they use native Go extensions to access facilities not otherwise
-available in Python.
+file and directory operations, are kept in the `grumpy-runtime-src/lib` subdir.
+In CPython these kinds of modules are written as C extensions. In Grumpy they
+are written in Python but they use native Go extensions to access facilities not
+otherwise available in Python.
 
 ### Source Code Overview
 
-- `compiler`: Python package implementating Python -> Go transcompilation logic.
-- `lib`: Grumpy-specific Python standard library implementation.
-- `runtime`: Go source code for the Grumpy runtime library.
-- `third_party/ouroboros`: Pure Python standard libraries copied from the
+- `grumpy-tools-src/grumpy_tools/compiler`: Python package implementating Python -> Go transcompilation logic.
+- `grumpy-runtime-src/lib`: Grumpy-specific Python standard library implementation.
+- `grumpy-runtime-src/runtime`: Go source code for the Grumpy runtime library.
+- `grumpy-runtime-src/third_party/ouroboros`: Pure Python standard libraries copied from the
    [Ouroboros project](https://github.com/pybee/ouroboros).
-- `third_party/pypy`: Pure Python standard libraries copied from PyPy.
-- `third_party/stdlib`: Pure Python standard libraries copied from CPython.
-- `tools`: Transcompilation and utility binaries.
+- `grumpy-runtime-src/third_party/pypy`: Pure Python standard libraries copied from PyPy.
+- `grumpy-runtime-src/third_party/stdlib`: Pure Python standard libraries copied from CPython.
+- `grumpy-tools-src/grumpy_tools/`: Transcompilation and utility CLI.
 
 ## Contact
 

bumpversion.readme

@@ -0,0 +1 @@
+bumpversion patch --verbose --dry-run

grumpy-runtime-src/AUTHORS.md

@@ -0,0 +1 @@
+../AUTHORS.md

grumpy-runtime-src/CONTRIBUTING.md

@@ -0,0 +1 @@
+../CONTRIBUTING.md

grumpy-runtime-src/LICENSE

@@ -0,0 +1 @@
+../LICENSE

grumpy-runtime-src/MANIFEST.in

@@ -0,0 +1,9 @@
+global-include *.py
+global-include *.go
+global-include *.mk
+global-include Makefile
+recursive-include tools *
+
+global-exclude *.egg-info/*
+
+recursive-exclude grumpy-tools-src *.go

Makefile → grumpy-runtime-src/Makefile

@@ -146,7 +146,7 @@ clean:
 run: $(RUNNER)
 	@$(RUNNER_BIN)
 
-test: $(ACCEPT_PASS_FILES) $(ACCEPT_PY_PASS_FILES) $(COMPILER_PASS_FILES) $(COMPILER_EXPR_VISITOR_PASS_FILES) $(COMPILER_STMT_PASS_FILES) $(RUNTIME_PASS_FILE) $(STDLIB_PASS_FILES)
+test: $(ACCEPT_PASS_FILES) $(ACCEPT_PY_PASS_FILES) $(RUNTIME_PASS_FILE) $(STDLIB_PASS_FILES)
 
 precommit: cover gofmt lint test
 
@@ -246,8 +246,8 @@ $(PYLINT_BIN):
 	@cd build/third_party && curl -sL https://pypi.io/packages/source/p/pylint/pylint-1.6.4.tar.gz | tar -zx
 	@cd build/third_party/pylint-1.6.4 && $(PYTHON) setup.py install --prefix $(ROOT_DIR)/build
 
-pylint: $(PYLINT_BIN) $(COMPILER_SRCS) $(PYTHONPARSER_SRCS) $(COMPILER_BIN) $(RUNNER_BIN) $(TOOL_BINS)
-	@$(PYTHON) $(PYLINT_BIN) $(COMPILER_SRCS) $(COMPILER_BIN) $(RUNNER_BIN) $(TOOL_BINS)
+pylint: $(PYLINT_BIN) $(COMPILER_SRCS) $(PYTHONPARSER_SRCS) $(TOOL_BINS)
+	@$(PYTHON) $(PYLINT_BIN) $(COMPILER_SRCS) $(filter-out %pydeps,$(TOOL_BINS))
 
 lint: golint pylint
 

grumpy-runtime-src/README.md

@@ -0,0 +1 @@
+../README.md

grumpy-runtime-src/grumpy_runtime/__init__.py

@@ -0,0 +1,15 @@
+# Copyright 2016 Google Inc. All Rights Reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+__version__ = '0.1.8'

grumpy-runtime-src/grumpy_runtime/data/gopath

@@ -0,0 +1 @@
+../../build/lib/grumpy_runtime/data/gopath