From 88e8089321de277c4d702c0b4dc760536195a494 Mon Sep 17 00:00:00 2001 From: John Reese Date: Sat, 19 Oct 2019 19:51:57 -0700 Subject: [PATCH] Readme/contributing updates --- CONTRIBUTING.md | 21 ++++++++------------- README.md | 10 +++++----- 2 files changed, 13 insertions(+), 18 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2c8707a..195e78a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,25 +2,21 @@ ## Preparation -You'll need to have Python 3.6 available for testing -(I recommend using [pyenv][] for this), and a clean -development environment (virtualenv is good). - -You can do this with pyenv and virtualenv: +You'll need to have Python 3.6 available for testing. +I recommend using [pyenv][] for this: $ pyenv install 3.6.5 $ pyenv shell 3.6.5 - $ python3 -m venv .venv - $ source .venv/bin/activate ## Setup -Once in your development environment, install the -appropriate linting tools and dependencies: +Create a fresh development enviroment, and install the +appropriate tools and dependencies: $ cd - $ make setup dev + $ make venv + $ source .venv/bin/activate ## Submitting @@ -31,8 +27,7 @@ that you have done the following: * Documented changes or features in README.md * Added appropriate license headers to new files * Written or modified tests for new functionality -* Used [black][] to format code appropriately -* Validated code with `make lint test` +* Used `make format` to format code appropriately +* Validated and tested code with `make lint test` -[black]: https://github.com/ambv/black [pyenv]: https://github.com/pyenv/pyenv diff --git a/README.md b/README.md index 16cf359..e801e37 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ aioitertools ============ -itertools for AsyncIO and mixed iterables. +Implementation of itertools, builtins, and more for AsyncIO and mixed-type iterables. [![build status](https://github.com/jreese/aioitertools/workflows/Build/badge.svg)](https://github.com/jreese/aioitertools/actions) [![code coverage](https://img.shields.io/codecov/c/gh/jreese/aioitertools)](https://codecov.io/gh/jreese/aioitertools) @@ -16,7 +16,7 @@ Install aioitertools requires Python 3.6 or newer. You can install it from PyPI: - $ pip3 install aioitertools + $ pip install aioitertools Usage @@ -72,7 +72,7 @@ async for value in islice(generator1(), 2, None, 2): ``` -See [builtins.py][builtins] and [itertools.py][itertools] for full documentation +See [builtins.py][] and [itertools.py][] for full documentation of functions and abilities. @@ -85,5 +85,5 @@ source license. This is my personal repository; the license you receive to my code is from me and not from my employer. See the `LICENSE` file for details. -[builtins]: https://github.com/jreese/aioitertools/blob/master/aioitertools/builtins.py -[itertools]: https://github.com/jreese/aioitertools/blob/master/aioitertools/itertools.py +[builtins.py]: https://github.com/jreese/aioitertools/blob/master/aioitertools/builtins.py +[itertools.py]: https://github.com/jreese/aioitertools/blob/master/aioitertools/itertools.py