Skip to content

Commit

Permalink
Update description
Browse files Browse the repository at this point in the history
  • Loading branch information
kdeldycke committed Aug 20, 2024
1 parent cfe7560 commit 2d1b687
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 10 deletions.
7 changes: 6 additions & 1 deletion docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,9 @@ To get additional utilities [for Pytest](pytest.md), you may need to install ext

```shell-session
$ pip install extra-platforms[pytest]
```
```

## Namning

> [!TIP]
> I wanted to call this package `platforms`, but it's already taken on PyPI. So I went with `extra-platforms` instead, to mark its affiliation with [Click Extra](https://github.com/kdeldycke/click-extra).
18 changes: 9 additions & 9 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@

## What is Extra Platforms?

- Provides a list of all known platforms.
- Detect the current platform, at the distribution level.
- Gather current platform metadata (version, codename, etc.).
- Group platforms into families.
- Manage collection of platforms and groups.
- Associate each platform and group to an emoji symbol.

> [!TIP]
> I wanted to call this package `platforms`, but it's already taken on PyPI. So I went with `extra-platforms` instead, to mark its affiliation with [Click Extra](https://github.com/kdeldycke/click-extra).
- Provides a list of all known platforms
- Detect the current platform, at the distribution level
- Gather current platform metadata (version, codename, etc.)
- Group platforms into families
- Manage collection of platforms and groups
- Associate each platform and group to an emoji symbol
- New conditional markers for `pytest`:
- `@skip_linux`, `@skip_macos` and `@skip_windows`
- `@unless_linux`, `@unless_macos` and `@unless_windows`

## Examples

Expand Down

0 comments on commit 2d1b687

Please sign in to comment.