From ba8d1706cc11519f12fd919a135442690a8e13a3 Mon Sep 17 00:00:00 2001 From: roll Date: Wed, 18 Dec 2019 15:43:06 +0300 Subject: [PATCH] Updated readme --- README.md | 28 ++-------------------------- 1 file changed, 2 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 2e7ea54..5970301 100644 --- a/README.md +++ b/README.md @@ -111,13 +111,12 @@ __Arguments__ ## Contributing -The project follows the [Open Knowledge International coding standards](https://github.com/okfn/coding-standards). +> The project follows the [Open Knowledge International coding standards](https://github.com/okfn/coding-standards). Recommended way to get started is to create and activate a project virtual environment. - To install package and development dependencies into active environment: -``` +```bash $ make install ``` @@ -127,29 +126,6 @@ To run tests with linting and coverage: $ make test ``` -For linting `pylama` configured in `pylama.ini` is used. On this stage it's already -installed into your environment and could be used separately with more fine-grained control -as described in documentation - https://pylama.readthedocs.io/en/latest/. - -For example to sort results by error type: - -```bash -$ pylama --sort -``` - -For testing `tox` configured in `tox.ini` is used. -It's already installed into your environment and could be used separately with more fine-grained control as described in documentation - https://testrun.org/tox/latest/. - -For example to check subset of tests against Python 2 environment with increased verbosity. -All positional arguments and options after `--` will be passed to `py.test`: - -```bash -tox -e py27 -- -v tests/ -``` - -Under the hood `tox` uses `pytest` configured in `pytest.ini`, `coverage` -and `mock` packages. This packages are available only in tox envionments. - ## Changelog Here described only breaking and the most important changes. The full changelog and documentation for all released versions could be found in nicely formatted [commit history](https://github.com/frictionlessdata/tableschema-ckan-datastore-py/commits/master).