Fixed typo in README and added instructions on how to virtualenv

[dnshio]

This looks like a really great open source project. I'd like to contribute to its development so I started reading your docs. I noticed a couple of small issues there so here's a PR to fix them.

With regards to instructions on virtualenv, I'm open to feedback on whether I should include more detail. Also, my improvement only recommends python's venv module rather than the independent virtualenv package. I believe in recommending a single tool and and python's venv module is best because it doesn't required additional installation.

Let me know how I could improve this PR.

[codecov]

Codecov Report

Merging #457 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #457   +/-   ##
=======================================
  Coverage   91.74%   91.74%           
=======================================
  Files          30       30           
  Lines        4654     4654           
=======================================
  Hits         4270     4270           
  Misses        384      384           

Flag	Coverage Δ
#py35	91.61% <ø> (ø)
#py36	91.61% <ø> (ø)
#py37	91.61% <ø> (ø)
#py38	91.56% <ø> (ø)
#py39	91.56% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 7d68d01...9cd0bc3. Read the comment docs.

[NiallRees]

This looks like a really great open source project. I'd like to contribute to its development so I started reading your docs. I noticed a couple of small issues there so here's a PR to fix them.

With regards to instructions on virtualenv, I'm open to feedback on whether I should include more detail. Also, my improvement only recommends python's venv module rather than the independent virtualenv package. I believe in recommending a single tool and and python's venv module is best because it doesn't required additional installation.

Let me know how I could improve this PR.

Yes Dinesh! I'm personally a big pipenv fan, have you used it and do you think it could be a good choice here rather than venv?

[pwildenhain]

I just noticed this as well the other day, thanks for fixing!

[dnshio]

😄 I thought this was intentionally left there for new comers!

[pwildenhain]

Yes Dinesh! I'm personally a big pipenv fan, have you used it and do you think it could be a good choice here rather than venv?

Personally, my vote is for venv 🤚 though if we start to run into tricky dependency issues, I could see opting for pipenv instead. poetry is also worth considering if you're going to consider pipenv since it's built specifically for packages.

[NiallRees]

Out of interest are you able to merge this now I've approved it @dnshio ? Or do I need to

[dnshio]

Yes Dinesh! I'm personally a big pipenv fan, have you used it and do you think it could be a good choice here rather than venv?

Personally, my vote is for venv 🤚 though if we start to run into tricky dependency issues, I could see opting for pipenv instead. poetry is also worth considering if you're going to consider pipenv since it's built specifically for packages.

Have used pipenv for a couple of projects and I ended up ditching it because it became more hassle than what it was worth. Maybe I didn't see the true power of it. But I grew to appreciate the simplicity of having either a setup.py or a requirements.txt with pinned versions (point versions) and let the client decide what virtual environment they want to use.

[dnshio]

Out of interest are you able to merge this now I've approved it @dnshio ? Or do I need to

I do not have permission to merge. Would be great if you could :)