Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
kiraware committed Sep 18, 2024
1 parent cd972ad commit b523fc6
Showing 1 changed file with 0 additions and 20 deletions.
20 changes: 0 additions & 20 deletions docs/how-to-guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,26 +149,6 @@ We really pay attention to testing coverage, therefore to
contribute we are expected to make tests and if possible increase
the code coverage.

To carry out testing, you need to prepare environment variables.
For example, environment variables are found in the `.env.example`
file. You can change the value according to what you have and save
it in the root of the project directory with the file name `.env`.

To set up environment variables we need `PASTEBIN_API_DEV_KEY`,
`PASTEBIN_USERNAME`, and `PASTEBIN_PASSWORD`. `PASTEBIN_API_DEV_KEY`
belongs to `PASTEBIN_USERNAME`. Then we also need `PASTEBIN_API_USER_KEY`,
to get it we can make a login() API call. Please remember that
`PASTEBIN_API_USER_KEY` MUST NOT belong to `PASTEBIN_USERNAME`,
so simply we have to have two pastebin accounts.

We have a doctest in src that we don't run it by default because
it's for testing code examples in the docstring. The code example
uses real API calls without mocks, it can cause the test to reach
the API call rate limit. To run doctest, just open the `pyproject.toml`
file and look at the `tool.pytest.ini_options` section in the
`testpaths` configuration there is only a `tests` folder, you can
add the `src` folder and run the test normally to run doctest in src.

### Documenting

We use [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/)
Expand Down

0 comments on commit b523fc6

Please sign in to comment.