Skip to content
This repository was archived by the owner on Jul 2, 2024. It is now read-only.

Commit d83d849

Browse files
authored
Support pip manager (#20)
* Added pip manager support Added requirements file. Packages hashes are omitted to avoid issue with the newest pip version. Updated readme file with instruction on how to operate using pip.
1 parent d956a01 commit d83d849

File tree

2 files changed

+57
-6
lines changed

2 files changed

+57
-6
lines changed

README.rst

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,11 @@ interview experience.
1515
Getting started
1616
===============
1717

18+
This section describes the general usage of the project.
19+
20+
Installing dependencies
21+
-----------------------
22+
1823
It's recommended to use `poetry`_ with this project. Otherwise you are to do
1924
some additional work while installing dependencies and configuring internal
2025
packages.
@@ -29,14 +34,31 @@ Once you've cloned the repository to your local machine install dependencies:
2934
3035
This will also install internal packages for future tests.
3136

37+
PIP support
38+
^^^^^^^^^^^
39+
40+
For whose, who prefer to use `pip`_ as a package manager, it's supported.
41+
However it's not a primary package manager for this project, so problems may
42+
still appear - please, report to bug tracker in case of any.
43+
44+
You will need to install project dependencies and source code.
45+
To do this use commands:
46+
47+
.. code-block::
48+
49+
pip install -r requirements.txt
50+
pip install -e .
51+
52+
.. _pip: https://pip.pypa.io/
53+
3254
Code health check
3355
-----------------
3456

3557
There are few dependencies installed to check the code health:
3658

37-
* pytest-cov
38-
* mypy
39-
* pylint
59+
- pytest-cov
60+
- mypy
61+
- pylint
4062

4163
They are acting as stand-alone commands, available from your terminal with
4264
poetry:
@@ -53,11 +75,11 @@ Running tox
5375
`tox`_ aims to automate and standardize testing in Python. It is a generic
5476
virtualenv management and test command line tool you can use for:
5577

56-
* checking that your package installs correctly with different Python versions
78+
- checking that your package installs correctly with different Python versions
5779
and interpreters
58-
* running your tests in each of the environments, configuring your test tool of
80+
- running your tests in each of the environments, configuring your test tool of
5981
choice
60-
* acting as a frontend to Continuous Integration servers, greatly reducing
82+
- acting as a frontend to Continuous Integration servers, greatly reducing
6183
boilerplate and merging CI and shell-based testing.
6284

6385
.. _tox: https://tox.wiki

requirements.txt

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
astroid==2.13.2; python_full_version >= "3.7.2"
2+
attrs==22.2.0; python_version >= "3.7"
3+
cachetools==5.2.1; python_version >= "3.7" and python_version < "4.0"
4+
chardet==5.1.0; python_version >= "3.7"
5+
colorama==0.4.6; sys_platform == "win32" and python_full_version >= "3.7.2" and (python_version >= "3.7" and python_full_version < "3.0.0" or python_full_version >= "3.7.0" and python_version >= "3.7") and (python_version >= "3.7" and python_full_version < "3.0.0" and sys_platform == "win32" or sys_platform == "win32" and python_version >= "3.7" and python_full_version >= "3.7.0")
6+
coverage==7.0.5; python_version >= "3.7"
7+
dill==0.3.6
8+
distlib==0.3.6; python_version >= "3.7"
9+
exceptiongroup==1.1.0; python_version < "3.11" and python_version >= "3.7"
10+
filelock==3.9.0; python_version >= "3.7"
11+
iniconfig==2.0.0; python_version >= "3.7"
12+
isort==5.11.4; python_full_version >= "3.7.2"
13+
lazy-object-proxy==1.9.0; python_version >= "3.7" and python_full_version >= "3.7.2"
14+
mccabe==0.7.0; python_version >= "3.6" and python_full_version >= "3.7.2"
15+
mypy-extensions==0.4.3; python_version >= "3.7"
16+
mypy==0.991; python_version >= "3.7"
17+
packaging==23.0; python_version >= "3.7"
18+
platformdirs==2.6.2; python_version >= "3.7" and python_full_version >= "3.7.2"
19+
pluggy==1.0.0; python_version >= "3.7"
20+
pylint==2.15.10; python_full_version >= "3.7.2"
21+
pyproject-api==1.4.0; python_version >= "3.7"
22+
pytest-cov==4.0.0; python_version >= "3.6"
23+
pytest==7.2.1; python_version >= "3.7"
24+
tomli==2.0.1; python_version < "3.11" and python_version >= "3.7" and python_full_version >= "3.7.2" and python_full_version <= "3.11.0a6"
25+
tomlkit==0.11.6; python_version >= "3.6" and python_full_version >= "3.7.2"
26+
tox==4.2.8; python_version >= "3.7"
27+
typing-extensions==4.4.0; python_version < "3.10" and python_full_version >= "3.7.2" and python_version >= "3.7"
28+
virtualenv==20.17.1; python_version >= "3.7"
29+
wrapt==1.14.1

0 commit comments

Comments
 (0)