Skip to content

Commit 6e44523

Browse files
committed
Refine the README
1 parent 9ddce04 commit 6e44523

File tree

2 files changed

+57
-2
lines changed

2 files changed

+57
-2
lines changed

MANIFEST.in

Lines changed: 0 additions & 1 deletion
This file was deleted.

README.md

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,30 @@ A web interface to browse and search packages in **any** simple package reposito
44

55
Built using FastAPI and the [simple-repository](https://github.com/simple-repository/simple-repository) core library.
66

7-
## Example
7+
## Usage
8+
9+
Install from PyPI:
10+
11+
```bash
12+
python -m pip install simple-repository-browser
13+
```
14+
15+
And run:
16+
17+
```bash
18+
simple-repository-browser
19+
```
20+
21+
(or alternatively ``python -m simple_repository_browser``)
22+
23+
By default, this will use the repository at PyPI (https://pypi.org/simple/). You can point it to a custom
24+
repository by passing the URL to the project list endpoint (the base URL according to PEP-503):
25+
26+
```bash
27+
simple-repository-browser https://my-custom-repository.example.com/foo/simple/
28+
```
29+
30+
## Screenshots:
831

932
Homepage:
1033

@@ -19,3 +42,36 @@ Search:
1942
Project page:
2043

2144
![example project page](https://raw.githubusercontent.com/simple-repository/simple-repository-browser/main/screenshots/project.png)
45+
46+
47+
48+
## Runtime details
49+
50+
```simple-repository-browser``` exposes a FastAPI application, and it runs the application in a single ``uvicorn`` worker.
51+
Metadata that is computed will be cached in the ``$XDG_CACHE_DIR/simple-repository-browser`` directory. This cache is not
52+
intended to be shared among different repository URLs, and is unlikely to work for multiple ``simple-repository-browser``
53+
versions. There is currently no intelligent cache invalidation for those cases.
54+
55+
56+
## Development
57+
58+
In order to build the ``simple-repository-browser``, first:
59+
60+
```bash
61+
cd javascript
62+
npm install --include=dev
63+
npm run build
64+
cd ..
65+
```
66+
67+
And then the normal installation procedure applies:
68+
69+
```bash
70+
python -m pip install -e .
71+
```
72+
73+
The browser can be run with:
74+
75+
```bash
76+
python -m simple_repository_browser
77+
```

0 commit comments

Comments
 (0)