chore(#1): consistent case, motivation, venv

h1alexbel · Apr 16, 2024 · f2e810f · f2e810f
1 parent 586825e
commit f2e810f
Show file tree

Hide file tree

Showing 2 changed files with 28 additions and 7 deletions.
diff --git a/.github/workflows/py.yml b/.github/workflows/py.yml
@@ -47,13 +47,12 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          python -m pip install flake8 pytest
-          pip install pylint
+          python -m pip install pytest pylint flake8
           pip install -r requirements.txt
-      - name: Test with pytest
+      - name: pytest
         run: |
           pytest
-      - name: Pylint
+      - name: pylint
         run: |
           pylint $(git ls-files '*.py')
       - name: Lint with flake8

diff --git a/README.md b/README.md
@@ -1,5 +1,13 @@
-build, pypi, puzzles,
-loc, hoc, license
+[![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org)
+[![DevOps By Rultor.com](http://www.rultor.com/b/h1alexbel/samples-filter)](http://www.rultor.com/p/h1alexbel/samples-filter)
+[![We recommend IntelliJ IDEA](https://www.elegantobjects.org/intellij-idea.svg)](https://www.jetbrains.com/idea/)
+
+[![py](https://github.com/h1alexbel/samples-filter/actions/workflows/py.yml/badge.svg)](https://github.com/h1alexbel/samples-filter/actions/workflows/py.yml)
+[![PyPI - Version](https://img.shields.io/pypi/v/samples-filter)]()
+[![PDD status](http://www.0pdd.com/svg?name=h1alexbel/samples-filter)](http://www.0pdd.com/p?name=h1alexbel/samples-filter)
+[![Hits-of-Code](https://hitsofcode.com/github/h1alexbel/samples-filter)](https://hitsofcode.com/view/github/h1alexbel/samples-filter)
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/h1alexbel/samples-filter/blob/master/LICENSE.txt)
+[![Known Vulnerabilities](https://snyk.io/test/github/h1alexbel/samples-filter/badge.svg)](https://snyk.io/test/github/h1alexbel/samples-filter)
 
 Samples-filter is a command-line filter
 for GitHub repositories that contain `samples`,
@@ -8,6 +16,12 @@ E.g. [leeowenowen/rxjava-examples](https://github.com/leeowenowen/rxjava-example
 [streaming-with-flink/examples-java](https://github.com/streaming-with-flink/examples-java), 
 [redisson/redisson-examples](https://github.com/redisson/redisson-examples).
 
+**Motivation**. During work on [cam](https://github.com/yegor256/cam) project,
+where we build datasets with open source Java programs, 
+we [discovered](https://github.com/yegor256/cam/issues/227)
+the need for filtering repositories that contain
+not a real code, but rather samples, tutorials or examples. 
+
 ## How to use
 
 TBD..
@@ -41,4 +55,12 @@ before sending us your pull request please run full build:
 $ ..
 ```
 
-You will need [Python 3.95+]() and [pip+]() installed.
+To set up virtual environment use this set of commands:
+
+```bash
+$ python3 -m venv $(pwd)
+$ source $(pwd)/venv/bin/activate
+```
+
+You will need [Python 3.9+](https://www.python.org/downloads/release/python-390)
+and [pip](https://pypi.org/project/pip) installed.