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

Commit 938645a

Browse files
authored
Release 2023.01.2 (#22)
### Brick Wall Challenge Added brick wall challenge. Original problem set is published at: https://leetcode.com/problems/brick-wall/ ### Project Itself - Moved project dependencies to dev-section. Project has dev-deps only. - From now pip package manage is supported as well. - Removed legacy documentation section from README
2 parents 738e6d4 + 747f1c6 commit 938645a

File tree

22 files changed

+580
-177
lines changed

22 files changed

+580
-177
lines changed

CHANGELOG.rst

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,22 @@
1+
#################
2+
Release 2023.01.2
3+
#################
4+
5+
********************
6+
Brick Wall Challenge
7+
********************
8+
9+
Added brick wall challenge. Original problem set is published at:
10+
https://leetcode.com/problems/brick-wall/
11+
12+
**************
13+
Project Itself
14+
**************
15+
16+
- Moved project dependencies to dev-section. Project has dev-deps only.
17+
- From now pip package manage is supported as well.
18+
- Removed legacy documentation section from README
19+
120
###############
221
Release 2023-01
322
###############
@@ -82,6 +101,6 @@ Tests are included as well.
82101
Warriors, Robbers and Wizards Game
83102
==================================
84103

85-
Added the basic "wrw game" challenge description and implementation. This tasks
104+
Added the basic "wrw game" challenge description and implementation. This task
86105
is considered to be the final exam for the OOP block. Tests are included as
87106
well.

README.rst

Lines changed: 28 additions & 10 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
@@ -81,7 +103,3 @@ There are two major directories: **src** and **tests**. Any useful code should
81103
be included to the source (src). Test cases for functions, classes etc. should
82104
lie inside of tests directory. It's ok to created nested packages within these
83105
directories if needed.
84-
85-
The **docs** directory contains optional config for the documentation generator
86-
and is used for documentation builds check only. The docs for this project are
87-
to be generated within the main project and another configuration will be used.

0 commit comments

Comments
 (0)