Skip to content
This repository has been archived by the owner on Mar 28, 2023. It is now read-only.

Commit

Permalink
Initial release work (#54)
Browse files Browse the repository at this point in the history
* chore(README): Add PyPI instructions

* chore(version): 0.0.1.pre.1

* chore(ci): Add an initial release workflow
  • Loading branch information
woodruffw authored Nov 12, 2020
1 parent afba079 commit 15b37b9
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 3 deletions.
33 changes: 33 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -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 }}
16 changes: 14 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 .
Expand Down
2 changes: 1 addition & 1 deletion tourniquet/version.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "1.0.0"
__version__ = "0.0.1.pre.1"

0 comments on commit 15b37b9

Please sign in to comment.