Skip to content

Commit

Permalink
Améliore le README et le raccourcit le nom des exécutables (#89)
Browse files Browse the repository at this point in the history
  • Loading branch information
Guts authored Jun 18, 2023
2 parents e816d36 + c0ddba4 commit f86d43c
Show file tree
Hide file tree
Showing 7 changed files with 41 additions and 18 deletions.
1 change: 1 addition & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
**/.gitignore
**/.project
**/.pytest_cache
**/.ruff_cache
**/.settings
**/.toolstarget
**/.venv
Expand Down
4 changes: 3 additions & 1 deletion .github/workflows/build_release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on:

paths:
- ".github/workflows/build_release.yml"
- "builder/**/*"
- "builder/"
- "geotribu_cli/**/*.py"
- "requirements/base.txt"

Expand All @@ -18,6 +18,8 @@ on:
branches: [main]
paths:
- ".github/workflows/build_release.yml"
- "builder/"
- "requirements/packaging.txt"

# Globals
env:
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,9 @@ venv.bak/
# Rope project settings
.ropeproject

# Ruff
**/.ruff_cache

# mkdocs documentation
/site

Expand Down
28 changes: 28 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,31 @@ Outil en ligne de commande pour les tâches récurrentes du projet Geotribu.
[![📦 Build & 🚀 Release](https://github.com/geotribu/cli/actions/workflows/build_release.yml/badge.svg)](https://github.com/geotribu/cli/actions/workflows/build_release.yml)
[![📚 Documentation](https://github.com/geotribu/cli/actions/workflows/documentation.yml/badge.svg)](https://github.com/geotribu/cli/actions/workflows/documentation.yml)
[![codecov](https://codecov.io/gh/geotribu/cli/branch/main/graph/badge.svg?token=YRLQ6OPFRL)](https://codecov.io/gh/geotribu/cli)

[![PyPi version badge](https://badgen.net/pypi/v/geotribu)](https://pypi.org/project/geotribu/)
[![PyPI - Downloads](https://img.shields.io/pypi/dm/geotribu)](https://pypi.org/project/geotribu/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/geotribu)](https://pypi.org/project/geotribu/)

## Installer

Via _pip_ :

```sh
pip install geotribu
```

Via Docker :

```sh
docker pull ghcr.io/geotribu/cli
```

Via un exécutable pré-compilé : [télécharger pour son système d'exploitation](https://github.com/geotribu/cli/releases/latest).

## Utiliser

```sh
geotribu --help
```

Pour plus d'informations, [consulter la documentation](https://cli.geotribu.fr/).
4 changes: 1 addition & 3 deletions builder/pyinstaller_build_macos.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,10 @@
PyInstaller.__main__.run(
[
"--log-level={}".format(getenv("PYINSTALLER_LOG_LEVEL", "WARN")),
"--name={}_{}_MacOS{}_Python{}-{}".format(
"--name={}_{}_MacOS{}".format(
__about__.__title_clean__,
__about__.__version__.replace(".", "-"),
mac_os_version,
platform.python_version_tuple()[0],
platform.python_version_tuple()[1],
),
"--noconfirm",
"--noupx",
Expand Down
9 changes: 3 additions & 6 deletions builder/pyinstaller_build_ubuntu.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@
# ##################################

# Standard library
import platform
import sys
from os import getenv
from pathlib import Path
Expand All @@ -30,14 +29,12 @@
PyInstaller.__main__.run(
[
"--log-level={}".format(getenv("PYINSTALLER_LOG_LEVEL", "WARN")),
"--name={}_{}_{}{}_{}_Python{}".format(
"--name={}_{}_{}{}.bin".format(
__about__.__title_clean__,
__about__.__version__,
__about__.__version__.replace(".", "-"),
distro.name(),
distro.version(),
platform.architecture()[0],
platform.python_version(),
).replace(".", "-"),
),
"--noconfirm",
"--noupx",
"--onefile",
Expand Down
10 changes: 2 additions & 8 deletions builder/pyinstaller_build_windows.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,8 @@
),
"--log-level={}".format(getenv("PYINSTALLER_LOG_LEVEL", "WARN")),
"--manifest={}".format((package_folder / "../builder/manifest.xml").resolve()),
"--name={}_{}_{}{}_Python{}-{}".format(
__about__.__title_clean__,
__about__.__version__.replace(".", "-"),
platform.system(),
platform.architecture()[0],
platform.python_version_tuple()[0],
platform.python_version_tuple()[1],
),
f"--name={__about__.__title_clean__}_{__about__.__version__.replace('.', '-')}_"
f"{platform.system()}{platform.architecture()[0]}",
"--noconfirm",
"--noupx",
"--onefile",
Expand Down

0 comments on commit f86d43c

Please sign in to comment.