Merge pull request #40 from crytic/python-package

Transform solc-select into a Python package

Author: arcz

Diff for: .github/workflows/pythonpublish.yml

@@ -0,0 +1,31 @@
+# This workflows will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Python
+      uses: actions/setup-python@v1
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install setuptools wheel twine
+    - name: Build and publish
+      env:
+        TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
+        TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+      run: |
+        python setup.py sdist bdist_wheel
+        twine upload dist/*

Diff for: Dockerfile

@@ -1,60 +1,36 @@
 # solc-select
-A script to quickly switch between Solidity compiler versions.
+A tool to quickly switch between Solidity compiler versions.
 
-It is becoming increasingly hard to run older versions of `solc`,
-particularly on macOS since there are no official binary releases.
-Versions prior to 0.5.0 no longer compile on macOS and are not
-maintained. This is a problem because older Ethereum contracts no
-longer compile on modern versions of Solidity. `solc-select` is a
-utility that allows one to run _any_ legacy version of Solidity simply
-by setting an environment variable.
+The tool is split into two CLI utilities:
+- `solc-select`: manages installing and setting different `solc` compiler versions
+- `solc`: wrapper around `solc` which picks the right version according to what was set via `solc-select`
 
-## Quickstart
-
-### OS X:
-```
-docker pull trailofbits/solc-select
-docker run --read-only -i --rm --entrypoint='/bin/sh' trailofbits/solc-select:latest -c 'cat /usr/bin/install.sh' | bash -e
-```
-
-This will install `solc` globally. If `solc` is already installed, you
-will be prompted to overwrite it.
-
-To install `solc` to a different directory, run the `docker` command or
-the install script, with the environment variable `PREFIX` set; `solc`
-will be installed to `${PREFIX}/bin/solc`.
+The `solc` binaries are downloaded from https://binaries.soliditylang.org/ which contains
+official artifacts for many historial and modern `solc` versions for Linux and macOS.
 
-Alternatively, manually copy [the special solc script](bin/solc) to your desired location.
+The downloaded binaries are stored in `~/.solc-select/artifacts/`.
 
-### Linux
-```
-git clone https://github.com/crytic/solc-select.git
-./solc-select/scripts/install.sh
-```
-
-This will install `solc` into ~/.solc-select/, so you have to add it to the PATH variable. Add this line, replacing USERNAME with your username, to your `.bashrc` or equivalent:
+## Quickstart
 
 ```
-export PATH=/home/USERNAME/.solc-select:$PATH
+pip3 install solc-select
 ```
 
-
 ## Usage
 
-The desired version of `solc` can be set with the `use` command. By default, the latest version is used.
-
+The global version of `solc` can be set with the `solc-select use <version>` command:
 ```
 $ solc --version
 solc, the solidity compiler commandline interface
 Version: 0.5.2+commit.1df8f40c.Linux.g++
-$ solc use 0.4.24
+$ solc-select use 0.4.24
+Switched global version to 0.4.24
+$ solc --version
 solc, the solidity compiler commandline interface
 Version: 0.4.24+commit.e67f0147.Linux.g++
 ```
 
-
-In special scenarios the current version can also be overwritten with the `SOLC_VERSION` environment variable.
-
+Use `SOLC_VERSION` environment variable to override the global version:
 ```
 $ solc --version
 solc, the solidity compiler commandline interface
@@ -64,63 +40,29 @@ solc, the solidity compiler commandline interface
 Version: 0.5.2+commit.1df8f40c.Linux.g++
 ```
 
-
-You can list all available versions with the special `--versions` argument:
+You can list all available versions with `solc-select install`:
 ```
-$ solc --versions
-0.4.11
-0.4.12
-0.4.13
-0.4.14
-0.4.15
-0.4.16
-0.4.17
-0.4.18
-0.4.19
-0.4.20
-0.4.21
-0.4.22
-0.4.23
-0.4.24
-0.4.25
-0.5.0
-0.5.1
-0.5.2
-0.5.3
-0.5.4
-0.5.5
-nightly
+$ solc-select install
+Available versions to install:
+0.3.6
+0.4.0
+...
+0.8.0
+0.8.1
 ```
 
-## Upgrading
-
-Once installed, simply run
+And install the one you need with with `solc-select install <version>`:
 ```
-solc --upgrade
+$ solc-select install 0.8.1
+Installing '0.8.1'...
+Version '0.8.1' installed.
 ```
-to automatically upgrade `solc-select`. This will automatically pull the latest Docker image (or repo source, depending on your OS) and upgrade the local `solc` script, if necessary. The [DockerHub image for `solc-select`](https://hub.docker.com/r/trailofbits/solc-select) will automatically update every time Solidity is updated, which will typically be nightly.
-
-## Installation from Source on OS X
-
-```
-$ git clone https://github.com/trailofbits/solc-select.git
-$ cd solc-select
-$ docker build -t trailofbits/solc-select:latest .
-$ bin/solc --install
-```
-
-## Experimental solc-select
-
-The experimental version of `solc-select` is a Python-based script without any
-additional dependencies. Both macOS and Linux solc binaries are downloaded from
-https://binaries.soliditylang.org/ and macOS binaries run natively. Some
-features are still missing, like version range installation or nightly builds.
 
-Try it out:
+Display the currently installed versions:
 ```
-git clone https://github.com/crytic/solc-select ~/.solc-select
-export PATH=~/.solc-select/experimental/bin:$PATH
-solc-select --help
+$ solc-select versions
+0.8.0
+0.4.2 (current, set by /Users/artur/.solc-select/global-version)
 ```
 
 ## Getting Help