Skip to content

Commit

Permalink
docs: add more description
Browse files Browse the repository at this point in the history
  • Loading branch information
petereon authored Feb 24, 2022
1 parent 0c847d3 commit e8fb0b3
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,12 @@

I wished my Python tests were more readable. Now yours can be too. :mag: :mag:

Expycted is not dependent on any testing framework and can plug into any as it is just an abstraction over `assert`.

Examples:
```python
from expycted import expect

expect(True).to_not.be_false() # This will succeed

expect([]).to.be_empty() # This will succeed
Expand All @@ -16,6 +20,8 @@ expect(10).to.be("10") # This will succeed

```

## Matchers

Currently available matchers are:

- Eqality and similarity
Expand All @@ -40,4 +46,4 @@ Currently available matchers are:
- `be_of_type(self, value)`: checks if `self.value` is of specified type
- `inherit(self, value)`: checks if `self.value` inherits/is a specified type

__Project is currently in its infancy, contributors and issues are welcome__
__Project is currently in its infancy, contributors, pull requests and issues are welcome__

0 comments on commit e8fb0b3

Please sign in to comment.