Skip to content

Commit

Permalink
fix installing page headers
Browse files Browse the repository at this point in the history
  • Loading branch information
fohrloop committed Sep 19, 2024
1 parent a0c6272 commit d58268c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 7 deletions.
1 change: 0 additions & 1 deletion docs/source/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
## wakepy 0.10.0
🗓️ unreleased


### ✨ Features
- Add support for BSD and other non-Linux Unix-like FOSS desktop systems. All systems running a supported Desktop Environment (currently: KDE, Gnome + other freedesktop compliant DEs) should be supported. ([#379](https://github.com/fohrloop/wakepy/pull/379), [#385](https://github.com/fohrloop/wakepy/pull/385))
- When running on an *unknown* platform, do not fail any Methods in the platform check phase anymore, but try to use each Method. This means for example that any system running GNOME that is not Linux (or BSD) could still use wakepy with the [org.gnome.SessionManager](https://wakepy.readthedocs.io/stable/methods-reference.html#org-gnome-sessionmanager) ([#379](https://github.com/fohrloop/wakepy/pull/379))
Expand Down
12 changes: 6 additions & 6 deletions docs/source/installing.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
## Installing
# Installing

The supported python versions are CPython 3.7, 3.8, 3.9, 3.10, 3.12 and 3.13 (PyPy support: [wakepy/#274](https://github.com/fohrloop/wakepy/issues/274)).

### PyPI
## PyPI
Wakepy may be installed from [PyPI](https://pypi.org/project/wakepy/) with pip (or [uv](https://github.com/astral-sh/uv)). For example:

```
Expand All @@ -15,7 +15,7 @@ Alternatively, if you are installing wakepy for the [CLI](#cli-api), you can use
pipx install wakepy
```

### GitHub releases
## GitHub releases

You may also install a release (.whl or .tar.gz) by downloading it from the [GitHub releases](https://github.com/fohrloop/wakepy/releases) and installing with the tool of your choise (e.g. pip / pipx / uv). For example:

Expand All @@ -25,11 +25,11 @@ pip install wakepy-0.9.1-py3-none-any.whl

Note that GitHub releases also contain the .sigstore files (e.g. `wakepy-0.9.1-py3-none-any.whl.sigstore`) which you may use to verify that an artifact has came from the [Publish a wakepy release 📦](https://github.com/fohrloop/wakepy/blob/main/.github/workflows/publish-a-release.yml) GitHub Action.

### Source code
## Source code

You may also install directly from the [source code](https://github.com/fohrloop/wakepy) by (forking and) cloning the repo. This way it's possible to also install an unreleased ("latest") version. If you do this, you might want to look at the [DEV.md](https://github.com/fohrloop/wakepy/blob/main/DEV.md)

### conda-forge
## conda-forge

Wakepy (>=0.9.1) is also published to [conda-forge](https://anaconda.org/conda-forge/wakepy), the community-led conda channel of installable packages. This means that you can install it with [conda](https://docs.conda.io/en/latest/):

Expand All @@ -52,5 +52,5 @@ conda config --set channel_priority strict

The [conda-forge/wakepy-feedstock](https://github.com/conda-forge/wakepy-feedstock) contains more information and is the source for the wakepy package in conda-forge.

### Other
## Installing notes
Note that to get the `wakepy` <a href="https://wakepy.readthedocs.io/stable/cli-api.html">CLI command</a> working, you might need to restart the shell / terminal application after installing.

0 comments on commit d58268c

Please sign in to comment.