Skip to content

Commit

Permalink
add link to the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
orsinium committed Apr 11, 2023
1 parent ed48d60 commit ede946c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# pytypest

Type-safe and maintainable fixtures and parametrization for pytest.
Type-safe and maintainable fixtures and parametrization for [pytest](https://github.com/pytest-dev/pytest).

Features:

+ 100% type safe.
+ Great IDE integration, go-todefinition always takes you in the right place.
+ Great IDE integration, go-to-definition always takes you in the right place.
+ Test parametrization that is redable even with many arguments.
+ Plug-and-play integration with pytest.
+ No vendor-lock, you can use only the features you need and don't touch the rest.
Expand Down Expand Up @@ -39,3 +39,5 @@ def test_user() -> None:
```

Compared to built-in pytest fixtures, these are explicit, type-safe, can accept arguments, support go-to-definition in IDE, and can be used as context managers. And like pytest fixtures, they are cached and can be scoped to the module or the whole session.

Read more in the **documentation**: [pytypest.orsinium.dev](https://pytypest.orsinium.dev/).
2 changes: 2 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@
:end-before: "## Usage"
```

**Source code:** [github.com/orsinium-labs/pytypest](https://github.com/orsinium-labs/pytypest).

```{eval-rst}
.. toctree::
:maxdepth: 1
Expand Down

0 comments on commit ede946c

Please sign in to comment.