Skip to content
This repository was archived by the owner on Jul 2, 2024. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 20 additions & 1 deletion CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,22 @@
#################
Release 2023.01.2
#################

********************
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

###############
Release 2023-01
###############
Expand Down Expand Up @@ -82,6 +101,6 @@ Tests are included as well.
Warriors, Robbers and Wizards Game
==================================

Added the basic "wrw game" challenge description and implementation. This tasks
Added the basic "wrw game" challenge description and implementation. This task
is considered to be the final exam for the OOP block. Tests are included as
well.
38 changes: 28 additions & 10 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,11 @@ interview experience.
Getting started
===============

This section describes the general usage of the project.

Installing dependencies
-----------------------

It's recommended to use `poetry`_ with this project. Otherwise you are to do
some additional work while installing dependencies and configuring internal
packages.
Expand All @@ -29,14 +34,31 @@ Once you've cloned the repository to your local machine install dependencies:

This will also install internal packages for future tests.

PIP support
^^^^^^^^^^^

For whose, who prefer to use `pip`_ as a package manager, it's supported.
However it's not a primary package manager for this project, so problems may
still appear - please, report to bug tracker in case of any.

You will need to install project dependencies and source code.
To do this use commands:

.. code-block::

pip install -r requirements.txt
pip install -e .

.. _pip: https://pip.pypa.io/

Code health check
-----------------

There are few dependencies installed to check the code health:

* pytest-cov
* mypy
* pylint
- pytest-cov
- mypy
- pylint

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

* checking that your package installs correctly with different Python versions
- checking that your package installs correctly with different Python versions
and interpreters
* running your tests in each of the environments, configuring your test tool of
- running your tests in each of the environments, configuring your test tool of
choice
* acting as a frontend to Continuous Integration servers, greatly reducing
- acting as a frontend to Continuous Integration servers, greatly reducing
boilerplate and merging CI and shell-based testing.

.. _tox: https://tox.wiki
Expand All @@ -81,7 +103,3 @@ There are two major directories: **src** and **tests**. Any useful code should
be included to the source (src). Test cases for functions, classes etc. should
lie inside of tests directory. It's ok to created nested packages within these
directories if needed.

The **docs** directory contains optional config for the documentation generator
and is used for documentation builds check only. The docs for this project are
to be generated within the main project and another configuration will be used.
Loading