Skip to content

Commit

Permalink
[clean] Removing references to 'test.pypi.org' index, or the 'develop…
Browse files Browse the repository at this point in the history
…' branch (no longer default)
  • Loading branch information
lpascal-ledger committed Feb 1, 2024
1 parent 9ddcab3 commit 099a348
Show file tree
Hide file tree
Showing 7 changed files with 16 additions and 37 deletions.
12 changes: 3 additions & 9 deletions .github/workflows/build_and_tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ jobs:

- name: Build & install
run: |
pip install --extra-index-url https://test.pypi.org/simple/ -U .[tests,all_backends]
pip install -U .[tests,all_backends]
pip install -U click>=8
- name: Download app binaries
Expand Down Expand Up @@ -81,14 +81,8 @@ jobs:
- name: Build Ragger Python package
run: |
pip install --upgrade pip build twine
if [[ ${{ github.ref }} == "refs/tags/"* ]]; \
then \
python -m build; \
pip install .
else \
PIP_EXTRA_INDEX_URL=https://test.pypi.org/simple/ python -m build; \
pip install --extra-index-url https://test.pypi.org/simple/ .
fi
python -m build
pip install .
python -m twine check dist/*
echo "TAG_VERSION=$(python -c 'from ragger import __version__; print(__version__)')" >> "$GITHUB_ENV"
Expand Down
8 changes: 1 addition & 7 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,7 @@ jobs:
sudo apt-get update
sudo apt-get install graphviz
- name: Install Python dependencies
run: |
if [[ ${{ github.ref }} == "refs/tags/"* ]]; \
then \
pip install .[doc]
else \
pip install --extra-index-url https://test.pypi.org/simple/ .[doc]
fi
run: pip install .[doc]
- name: Generating automatic resources
run: (cd doc && make gen_resources)
- name: Generate the documentation
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Ragger

[![codecov](https://codecov.io/gh/LedgerHQ/ragger/branch/develop/graph/badge.svg)](https://codecov.io/gh/LedgerHQ/ragger)
[![codecov](https://codecov.io/gh/LedgerHQ/ragger/branch/master/graph/badge.svg)](https://codecov.io/gh/LedgerHQ/ragger)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=LedgerHQ_ragger&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=LedgerHQ_ragger)
[![CodeQL](https://github.com/LedgerHQ/ragger/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/LedgerHQ/ragger/actions/workflows/codeql-analysis.yml)

Expand Down Expand Up @@ -32,7 +32,7 @@ More complete documentation can be found [here](https://ledgerhq.github.io/ragge

### Python package

Ragger is available on https://pypi.org. To install it, just run:
Ragger is available on https://pypi.org. To install it fully, just run:

```
pip install ragger[all_backends]
Expand Down
2 changes: 1 addition & 1 deletion doc/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ installed with ``pip``:

.. code-block:: bash
pip install --extra-index-url https://test.pypi.org/simple/ ragger
pip install ragger
By default - to avoid wasting useless time and space - the ``ragger`` package
Expand Down
17 changes: 5 additions & 12 deletions doc/tutorial_installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,9 @@ dependencies:

.. code-block:: bash
$ pip install --extra-index-url https://test.pypi.org/simple/ ragger[speculos]
$ pip install ragger[speculos]
Some explanation on arguments:

- ``--extra-index-url https://test.pypi.org/simple/`` is necessary to get the
latest version of ``Ragger``, as it is currently not deployed on the
stable ``pypi`` repositories.
- ``ragger[speculos]`` means than Speculos and its dependencies will also
be installed. ``Ragger`` tries to uncouple its dependencies so that only
what is needed is installed.
All the extras can be seen
`in the setup.cfg <https://github.com/LedgerHQ/ragger/blob/develop/setup.cfg#L36-L100>`_
file.
``ragger[speculos]`` means than Speculos and its dependencies will also be
installed. ``Ragger`` tries to uncouple its dependencies so that only what is
needed is installed. All the extras can be seen in the `setup.cfg
<https://github.com/LedgerHQ/ragger/blob/master/setup.cfg#L39-L74>`_ file.
5 changes: 2 additions & 3 deletions src/ragger/backend/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,8 @@
from .interface import BackendInterface, RaisePolicy
from .stub import StubBackend


ERROR_MSG = "This backend needs {}. Please install this package (run `pip install " \
"--extra-index-url https://test.pypi.org/simple/ ragger[{}]` or check this address: '{}')"
ERROR_MSG = ("This backend needs {}. Please install this package (run `pip install ragger[{}]` or "
"check this address: '{}')")

try:
from .speculos import SpeculosBackend
Expand Down
5 changes: 2 additions & 3 deletions template/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ This framework allows testing the application on the Speculos emulator or on a r
### Install ragger and dependencies

```
pip install --extra-index-url https://test.pypi.org/simple/ -r requirements.txt
sudo apt-get update && sudo apt-get install qemu-user-static
pip install .[speculos]
```

### Compile the application
Expand Down Expand Up @@ -61,7 +61,7 @@ Standard useful pytest options
-s enable logs for successful tests, on Speculos it will enable app logs if compiled with DEBUG=1
-k <testname> only run the tests that contain <testname> in their names
--tb=short in case of errors, formats the test traceback in a readable way
```
```

Custom pytest options
```
Expand All @@ -72,4 +72,3 @@ Custom pytest options
--log_apdu_file <filepath> log all apdu exchanges to the file in parameter. The previous file content is erased
--seed on Speculos, use the seed (mnemonic) provided.
```

0 comments on commit 099a348

Please sign in to comment.