Creating Hyperskill problems

About Hyperskill problems

On Hyperskill, testing with the hs-test-python library is used when testing stages of projects. However, it is possible to use this library to write standalone problems for various topics in the knowledge map. The specifics of creating such problems will be described below.

We'll continue from the end of the Python's initial setup page.
If you want to create a problem for a non-Python language, you can start from non-Python languages initial setup page.

Differences from projects

There are several key differences between projects on Hyperskill and problems on Hyperskill using the hs-test-python library:

1. In the projects the initial template is only present in the first stage, while in the problems the initial template is present in every stage. This is because in projects, the user's solution moves from stage to stage, whereas problems can be solved by the user in any order and are actually independent of each other.
2. In projects, only tests are hidden and all solution files must be visible to the user. In problems, part of the solution can be hidden and the user will only see a visible part of the solution to make changes in it. For a problem that can be solved in the Hyperskill web interface, it must have only one visible file (but it may contain more than one visible file, in this case it can be solved only in IDE).

You can create several problems in within single JetBrains Academy project.

Requirements

If you want your solution to be solvable in the web-interface, there are some requirements you have to follow:

1. Tests and solution should not connect to the internet since they are being run inside an isolated environment. However, you can host the server on localhost and solution can connect to it.
2. Tests and solution should not use additional libraries not included in the standard library. You can ask Hyperskill team for including some libraries to be installed inside an isolated environment
3. Solution should have only 1 visible file, other solution files (if they exist) should be hidden since Hyperskill frontend only supports editing one file, not many.

Important: If the language of tests doesn't match with the language of the solution, then it will be tested on Hyperskill side even if it is opened locally in the IDE with the JetBrains Academy plugin. Therefore, all the requirements above (except point 3) should be considered even if you plan the problem to be solved in the IDE only.

So, to summarize:

1. Tests written in Python and solution in Python

   1. Consider all restrictions if you want the problem to be solved in web-interface and in IDE.
   2. No restrictions if you want the problem to be solved only in IDE.

2. Tests written in Python and solution in Go/Bash/JavaScript

   1. Consider all restrictions if you want the problem to be solved in web-interface and in IDE.
   2. Consider all restrictions (except point 3) if you want the problem to be solved only in IDE.

General thoughts

Here are general thoughts on creating problems on Hyperskill:

1. Try to leave only 1 visible file, so that users will be able to solve the problem in the web interface. It is quite important for the users.
2. Try to leave all the necessary imports in place so that users won't struggle with them since they don't have code completion when they try to solve the problem in the web interface. But at the same time, don't hint the exact solution by showing exact imports. For example, in Python and Java you can use star imports so that the user wouldn't be spoiled the solution and at the same time wouldn't have to type imports.
3. You don't have to edit task.html in JetBrains Academy, it's better to edit it on Cogniterra. But be aware that you shouldn't edit problem description on Cogniterra while you edit tests in JetBrains Academy - you will end up erasing either description on Cogniterra or tests in JetBrains Academy. After you made some edits on Cogniterra, you need to redownload the lesson in JetBrains Academy or copy HTML description in Cogniterra and paste it to task.html in the same step in IDE.