https://github.com/vanilla-os/eratosthenes
APT Repository browser and indexer for Vanilla OS
https://github.com/vanilla-os/eratosthenes
apt apt-browser hacktoberfest indexer repo-index vanillaos
Last synced: 7 months ago
JSON representation
APT Repository browser and indexer for Vanilla OS
- Host: GitHub
- URL: https://github.com/vanilla-os/eratosthenes
- Owner: Vanilla-OS
- License: agpl-3.0
- Created: 2023-04-02T21:31:32.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-02-26T05:11:04.000Z (7 months ago)
- Last Synced: 2025-02-26T06:18:56.386Z (7 months ago)
- Topics: apt, apt-browser, hacktoberfest, indexer, repo-index, vanillaos
- Language: HTML
- Homepage: https://packages.vanillaos.org
- Size: 117 KB
- Stars: 3
- Watchers: 1
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
---
Eratosthenes is an APT repository browser and indexer, designed for Vanilla OS.
## Requirements
You can install all the requirements with `pip install -r requirements.txt`.
## Usage
To run the indexer, simply run `python3 eratosthenes.py index`. This will create
the database and index the repository.
To run the web server, run `python3 eratosthenes.py serve`. This will start a web
server on port `5000` by default, but you can change it in the configuration
file as explained below.
## Configuration
To configure your repository and database, add a `config.py` file:
```py
import os
DB_PATH = "eratosthenes.db"
BRANCHES = {
"main": "https://repo2.vanillaos.org/dists/sid/@/binary-amd64/Packages",
"testing": "https://testing.vanillaos.org/dists/sid/@/binary-amd64/Packages",
}
REPO_COMPONENTS = ["main", "contrib", "non-free-firmware", "non-free"]
PORT = 6001
DEBUG = True
```
Where,
- `DB_PATH` allows setting the path to the Eratosthenes database containing the repository index.
- `BRANCHES` allows adding branches from multiple repositories or within the same repository (it is displayed in the frontend in the same order as configured here).
- `REPO_COMPONENTS` allows adding components or tags for repositories.
- `PORT` allows setting Eratosthenes to run in a custom port.
- `DEBUG` allows displaying a debug log in the server's output
## Setting up a Development server
### Set the Environment
```bash
python3 -m venv env
source ./env/bin/activate
pip install -r requirements.txt
```
### Build Index & Start the server
```bash
python3 eratosthenes.py index
python3 eratosthenes.py serve
```
### Re-build Tailwind CSS
```bash
pnpx tailwindcss -i ./static/src/input.css -o ./static/dist/css/output.css --watch
```
## Why the name Eratosthenes?
Eratosthenes was a Greek mathematician, astronomer, and geographer. This is a
repository indexer and browser, so I thought it was a good name.