From 15b37b9dfe4c9b0511f3996c61f056e67a88bb54 Mon Sep 17 00:00:00 2001 From: William Woodruff Date: Thu, 12 Nov 2020 13:59:35 -0500 Subject: [PATCH] Initial release work (#54) * chore(README): Add PyPI instructions * chore(version): 0.0.1.pre.1 * chore(ci): Add an initial release workflow --- .github/workflows/release.yml | 33 +++++++++++++++++++++++++++++++++ README.md | 16 ++++++++++++++-- tourniquet/version.py | 2 +- 3 files changed, 48 insertions(+), 3 deletions(-) create mode 100644 .github/workflows/release.yml diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml new file mode 100644 index 0000000..52fe08b --- /dev/null +++ b/.github/workflows/release.yml @@ -0,0 +1,33 @@ +on: + push: + tags: + - 'v*' + +name: release + +jobs: + pypi: + name: upload release to PyPI + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v2 + - uses: actions/setup-python@v1 + with: + python-version: 3.8 + - name: create release + id: create_release + uses: actions/create-release@v1 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + tag_name: ${{ github.ref }} + release_name: Release ${{ github.ref }} + draft: false + prerelease: ${{ contains(github.ref, 'pre') || contains(github.ref, 'rc') }} + - name: sdist + run: python3 setup.py sdist + - name: publish + uses: pypa/gh-action-pypi-publish@master + with: + user: __token__ + password: ${{ secrets.PYPI_TOKEN }} diff --git a/README.md b/README.md index 653c99c..f70161f 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,21 @@ A Python library for easy C/C++ syntax guided program transformation/repair. This is still very early in development. -## Quickstart +## Installation -Build the library with docker +### PyPI + +Tourniquet is available via PyPI: + +```bash +$ pip install tourniquet +``` + +You'll need a relatively recent CMake and LLVM (9, 10, and 11 are supported). + +### Docker + +Tourniquet can also be built and run within a Docker container: ```bash $ docker build -t trailofbits/tourniquet . diff --git a/tourniquet/version.py b/tourniquet/version.py index 5becc17..e789bac 100644 --- a/tourniquet/version.py +++ b/tourniquet/version.py @@ -1 +1 @@ -__version__ = "1.0.0" +__version__ = "0.0.1.pre.1"