Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs post-release of 1.0.1 #412

Merged
merged 1 commit into from
Jul 1, 2024
Merged

Update docs post-release of 1.0.1 #412

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion docs/development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,15 @@ The website is built using [MkDocs](https://www.mkdocs.org/) and [Material for M

While developing the website, you can run `just docs-dev` to start a local server that will automatically reload when you make changes. This will create a virtual environment in `.venv` and install the necessary dependencies.

To build the docs, use `just docs`. This will create a virtual environment like `just docs-dev`.
To build the docs, use `just docs`.

## Releasing

1. Adjust the version number in [`Cargo.toml`](https://github.com/brettcannon/python-launcher/blob/main/Cargo.toml) (previous [releases](https://github.com/brettcannon/python-launcher/releases)).
1. Check that the relevant [action workflows](https://github.com/brettcannon/python-launcher/actions) are passing.
1. Run the [`release` pipeline](https://github.com/brettcannon/python-launcher/actions/workflows/release.yml).
1. Publish the [release](https://github.com/brettcannon/python-launcher/releases).
1. Make sure the docs are up-to-date based on the published version (e.g. the [installation instructions](install.md) link to the newest files)
1. Update the
[Homebrew formula](https://github.com/Homebrew/homebrew-core/blob/master/Formula/python-launcher.rb)
1. Get the URL to the
Expand Down
82 changes: 42 additions & 40 deletions docs/install.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ def platform_download(platform):
cog.outl(instructions)

]]] -->

<!-- [[[end]]] -->

There are three ways to install the Python Launcher for Unix:
Expand Down Expand Up @@ -63,57 +62,73 @@ Requires Fedora 34 or higher.

- https://src.fedoraproject.org/rpms/rust-python-launcher/

### [NixOS](https://nixos.org/)

To try the Launcher out:
```console
nix-shell -p python-launcher
```

- https://search.nixos.org/packages?type=packages&query=python-launcher
- https://github.com/NixOS/nixpkgs/blob/nixos-unstable/pkgs/development/tools/misc/python-launcher/default.nix

### Pre-built binaries

#### RISC-V
<!-- [[[cog
platform_download("riscv64gc-unknown-linux-gnu")
]]] -->
1. [Download `python_launcher-1.0.0-riscv64gc-unknown-linux-gnu.tar.xz`](https://github.com/brettcannon/python-launcher/releases/download/v1.0.0/python_launcher-1.0.0-riscv64gc-unknown-linux-gnu.tar.xz):

```console
curl --location --remote-name https://github.com/brettcannon/python-launcher/releases/download/v1.0.0/python_launcher-1.0.0-riscv64gc-unknown-linux-gnu.tar.xz
1. [Download `python_launcher-1.0.1-riscv64gc-unknown-linux-gnu.tar.xz`](https://github.com/brettcannon/python-launcher/releases/download/v1.0.1/python_launcher-1.0.1-riscv64gc-unknown-linux-gnu.tar.xz):

```
curl --location --remote-name https://github.com/brettcannon/python-launcher/releases/download/v1.0.1/python_launcher-1.0.1-riscv64gc-unknown-linux-gnu.tar.xz
```

2. Install into, e.g. `/usr/local`:

```console
tar --extract --strip-components 1 --directory /usr/local --file python_launcher-1.0.0-riscv64gc-unknown-linux-gnu.tar.xz
```
tar --extract --strip-components 1 --directory /usr/local --file python_launcher-1.0.1-riscv64gc-unknown-linux-gnu.tar.xz
```

<!-- [[[end]]] -->

#### AArch64
<!-- [[[cog
platform_download("aarch64-unknown-linux-gnu")
]]] -->
1. [Download `python_launcher-1.0.0-aarch64-unknown-linux-gnu.tar.xz`](https://github.com/brettcannon/python-launcher/releases/download/v1.0.0/python_launcher-1.0.0-aarch64-unknown-linux-gnu.tar.xz):

```console
curl --location --remote-name https://github.com/brettcannon/python-launcher/releases/download/v1.0.0/python_launcher-1.0.0-aarch64-unknown-linux-gnu.tar.xz
1. [Download `python_launcher-1.0.1-aarch64-unknown-linux-gnu.tar.xz`](https://github.com/brettcannon/python-launcher/releases/download/v1.0.1/python_launcher-1.0.1-aarch64-unknown-linux-gnu.tar.xz):

```
curl --location --remote-name https://github.com/brettcannon/python-launcher/releases/download/v1.0.1/python_launcher-1.0.1-aarch64-unknown-linux-gnu.tar.xz
```

2. Install into, e.g. `/usr/local`:

```console
tar --extract --strip-components 1 --directory /usr/local --file python_launcher-1.0.0-aarch64-unknown-linux-gnu.tar.xz
```
tar --extract --strip-components 1 --directory /usr/local --file python_launcher-1.0.1-aarch64-unknown-linux-gnu.tar.xz
```

<!-- [[[end]]] -->

#### x86-64
<!-- [[[cog
platform_download("x86_64-unknown-linux-gnu")
]]] -->
1. [Download `python_launcher-1.0.0-x86_64-unknown-linux-gnu.tar.xz`](https://github.com/brettcannon/python-launcher/releases/download/v1.0.0/python_launcher-1.0.0-x86_64-unknown-linux-gnu.tar.xz):

```console
curl --location --remote-name https://github.com/brettcannon/python-launcher/releases/download/v1.0.0/python_launcher-1.0.0-x86_64-unknown-linux-gnu.tar.xz
1. [Download `python_launcher-1.0.1-x86_64-unknown-linux-gnu.tar.xz`](https://github.com/brettcannon/python-launcher/releases/download/v1.0.1/python_launcher-1.0.1-x86_64-unknown-linux-gnu.tar.xz):

```
curl --location --remote-name https://github.com/brettcannon/python-launcher/releases/download/v1.0.1/python_launcher-1.0.1-x86_64-unknown-linux-gnu.tar.xz
```

2. Install into, e.g. `/usr/local`:

```console
tar --extract --strip-components 1 --directory /usr/local --file python_launcher-1.0.0-x86_64-unknown-linux-gnu.tar.xz
```
tar --extract --strip-components 1 --directory /usr/local --file python_launcher-1.0.1-x86_64-unknown-linux-gnu.tar.xz
```

<!-- [[[end]]] -->

## macOS
Expand Down Expand Up @@ -142,8 +157,8 @@ brew install python-launcher
```

That will symlink the `python3.10` command. It will also overwrite
what `python3` points at, so you may want to run the `brew link` command for the
newest version of Python you have installed last.
what `python3` points at, meaning it may not point at the newest release of
Python. Luckily the Python Launcher for Unix deals with this exact issue. 😁


### Pre-built binaries
Expand All @@ -152,51 +167,38 @@ brew install python-launcher
<!-- [[[cog
platform_download("aarch64-apple-darwin")
]]] -->
1. [Download `python_launcher-1.0.0-aarch64-apple-darwin.tar.xz`](https://github.com/brettcannon/python-launcher/releases/download/v1.0.0/python_launcher-1.0.0-aarch64-apple-darwin.tar.xz):

1. [Download `python_launcher-1.0.1-aarch64-apple-darwin.tar.xz`](https://github.com/brettcannon/python-launcher/releases/download/v1.0.1/python_launcher-1.0.1-aarch64-apple-darwin.tar.xz):

```
curl --location --remote-name https://github.com/brettcannon/python-launcher/releases/download/v1.0.0/python_launcher-1.0.0-aarch64-apple-darwin.tar.xz
curl --location --remote-name https://github.com/brettcannon/python-launcher/releases/download/v1.0.1/python_launcher-1.0.1-aarch64-apple-darwin.tar.xz
```

2. Install into, e.g. `/usr/local`:

```
tar --extract --strip-components 1 --directory /usr/local --file python_launcher-1.0.0-aarch64-apple-darwin.tar.xz
tar --extract --strip-components 1 --directory /usr/local --file python_launcher-1.0.1-aarch64-apple-darwin.tar.xz
```

<!-- [[[end]]] -->

#### x86-64
<!-- [[[cog
platform_download("x86_64-apple-darwin")
]]] -->
1. [Download `python_launcher-1.0.0-x86_64-apple-darwin.tar.xz`](https://github.com/brettcannon/python-launcher/releases/download/v1.0.0/python_launcher-1.0.0-x86_64-apple-darwin.tar.xz):

```
curl --location --remote-name https://github.com/brettcannon/python-launcher/releases/download/v1.0.0/python_launcher-1.0.0-x86_64-apple-darwin.tar.xz
```

2. Install into, e.g. `/usr/local`:
1. [Download `python_launcher-1.0.1-x86_64-apple-darwin.tar.xz`](https://github.com/brettcannon/python-launcher/releases/download/v1.0.1/python_launcher-1.0.1-x86_64-apple-darwin.tar.xz):

```
tar --extract --strip-components 1 --directory /usr/local --file python_launcher-1.0.0-x86_64-apple-darwin.tar.xz
```
<!-- [[[end]]] -->

## NetBSD (x86-64 binary)
<!-- [[[cog
platform_download("x86_64-unknown-netbsd")
]]] -->
1. [Download `python_launcher-1.0.0-x86_64-unknown-netbsd.tar.xz`](https://github.com/brettcannon/python-launcher/releases/download/v1.0.0/python_launcher-1.0.0-x86_64-unknown-netbsd.tar.xz):

```
curl --location --remote-name https://github.com/brettcannon/python-launcher/releases/download/v1.0.0/python_launcher-1.0.0-x86_64-unknown-netbsd.tar.xz
curl --location --remote-name https://github.com/brettcannon/python-launcher/releases/download/v1.0.1/python_launcher-1.0.1-x86_64-apple-darwin.tar.xz
```

2. Install into, e.g. `/usr/local`:

```
tar --extract --strip-components 1 --directory /usr/local --file python_launcher-1.0.0-x86_64-unknown-netbsd.tar.xz
tar --extract --strip-components 1 --directory /usr/local --file python_launcher-1.0.1-x86_64-apple-darwin.tar.xz
```

<!-- [[[end]]] -->

## From source
Expand Down
Loading