From c6107cea86223f8a54bfc6d523cc4be06ed46e3a Mon Sep 17 00:00:00 2001 From: Ivan Sinkarenko Date: Thu, 20 Nov 2025 09:31:58 +0100 Subject: [PATCH 1/2] Document how to disable indexing --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 0f4664a..9d7bc51 100644 --- a/README.md +++ b/README.md @@ -82,6 +82,12 @@ And then the normal installation procedure applies: python -m pip install -e . ``` +You may want to disable the indexing to avoid long-running tasks during the development: + +```bash +export DISABLE_REPOSITORY_INDEXING=1 +``` + The browser can be run with: ```bash From 8a1f980d297dded0b9ea1cd9d4642b28723631cb Mon Sep 17 00:00:00 2001 From: Ivan Sinkarenko Date: Thu, 20 Nov 2025 09:39:41 +0100 Subject: [PATCH 2/2] Fix markdown issues --- .markdownlint.yaml | 2 ++ .pre-commit-config.yaml | 8 ++++++++ README.md | 11 +++-------- 3 files changed, 13 insertions(+), 8 deletions(-) create mode 100644 .markdownlint.yaml diff --git a/.markdownlint.yaml b/.markdownlint.yaml new file mode 100644 index 0000000..77abf70 --- /dev/null +++ b/.markdownlint.yaml @@ -0,0 +1,2 @@ +MD013: + line_length: 200 diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 80c650d..8b3ea4a 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -5,3 +5,11 @@ repos: - id: ruff-check args: ["--fix", "--select=I"] - id: ruff-format + - repo: https://github.com/igorshubovych/markdownlint-cli + rev: v0.46.0 + hooks: + - id: markdownlint + args: + - '--config' + - './.markdownlint.yaml' + - '--' diff --git a/README.md b/README.md index 9d7bc51..5f823ea 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ Built using FastAPI and the [simple-repository](https://github.com/simple-reposi ## Demo -A tech-preview demo is available at https://simple-repository.app.cern.ch/. +A tech-preview demo is available at . ## Usage @@ -24,31 +24,27 @@ simple-repository-browser (or alternatively ``python -m simple_repository_browser``) -By default, this will use the repository at PyPI (https://pypi.org/simple/). You can point it to a custom +By default, this will use the repository at PyPI (). You can point it to a custom repository by passing the URL to the project list endpoint (the base URL according to PEP-503): ```bash simple-repository-browser https://my-custom-repository.example.com/foo/simple/ ``` -## Screenshots: +## Screenshots Homepage: ![homepage screenshot](https://raw.githubusercontent.com/simple-repository/simple-repository-browser/main/screenshots/home.png) - Search: ![search result](https://raw.githubusercontent.com/simple-repository/simple-repository-browser/main/screenshots/search.png) - Project page: ![example project page](https://raw.githubusercontent.com/simple-repository/simple-repository-browser/main/screenshots/project.png) - - ## Runtime details ```simple-repository-browser``` exposes a FastAPI application, and it runs the application in a single ``uvicorn`` worker. @@ -56,7 +52,6 @@ Metadata that is computed will be cached in the ``$XDG_CACHE_DIR/simple-reposito intended to be shared among different repository URLs, and is unlikely to work for multiple ``simple-repository-browser`` versions. There is currently no intelligent cache invalidation for those cases. - ## Development In order to build the ``simple-repository-browser`` you will need access to npm. If not available on the development host,