Skip to content

Commit

Permalink
Update readme to use commited wheel version
Browse files Browse the repository at this point in the history
  • Loading branch information
alvinlindstam committed Jun 13, 2019
1 parent a287185 commit 1bd358b
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,13 @@ This module exposes the necessary API to create a worker which starts polling me
We can install the library through github by writing the dependency in `requirements.txt` as:

```
git+https://github.com/epidemicsound/aws-sqs-worker.git#egg=aws-sqs-worker
https://raw.githubusercontent.com/epidemicsound/aws-sqs-worker/master/wheels/aws_sqs_worker-0.0.1-py3-none-any.whl
```

Replace 0.0.1 with the desired version!

If using pipenv, you can also run `pipenv install https://raw.githubusercontent.com/epidemicsound/aws-sqs-worker/master/wheels/aws_sqs_worker-0.0.1-py3-none-any.whl`.

## Steps necessary to create a worker for the process:

1. Create a worker class with a method to handle the payload from the queue that the worker is created for. An example is as follows:
Expand Down Expand Up @@ -45,3 +49,16 @@ queue_worker.start()
```

This will then start the queue polling mechanism by the `queue_worker`. As soon as message appears on the `queue_name`, it invokes the `handle_payload` function of `myworker` instance.

## Release

Use semantic versioning for this library. When bumping the version, please update the version in:

* setup.py
* this readme

Make sure you generate a new wheel (after bumping the version) by running `make build-release`.

Make sure that the new wheel is named `aws_sqs_worker-<version>-py3-none-any.whl` and is in the `wheels` folder..

Include the wheel in git.

0 comments on commit 1bd358b

Please sign in to comment.