Rename as SimpleXNG.

Author: jlevy

.copier-answers.yml

@@ -5,5 +5,5 @@ package_author_email: joshua@cal.berkeley.edu
 package_author_name: Joshua Levy
 package_description: Package of SearXNG for easy local usage
 package_github_org: jlevy
-package_module: searxng_local
-package_name: searxng-local
+package_module: simplexng
+package_name: simplexng

.github/workflows/ci.yml

@@ -53,6 +53,9 @@ jobs:
       #   with:
       #     python-version: ${{ matrix.python-version }}
 
+      - name: Prepare searxng build dependencies
+        run: uv sync --extras build
+
       - name: Install all dependencies
         run: uv sync --all-extras --dev
 

.github/workflows/publish.yml

@@ -27,6 +27,9 @@ jobs:
 
       - name: Set up Python (using uv)
         run: uv python install
+        
+      - name: Prepare searxng build dependencies
+        run: uv sync --extras build
 
       - name: Install all dependencies
         run: uv sync --all-extras --dev

README.md

@@ -1,15 +1,18 @@
-# searxng-local
+# SimpleXNG
 
 SimpleXNG is a simplified package of [SearXNG](https://github.com/searxng/searxng) to
 make it a single command to run for local use.
 
-The [official install options](https://docs.searxng.org/admin/installation.html) all
-seemed quite complex if all you want to do is run it locally.
+The [official install options](https://docs.searxng.org/admin/installation.html) for
+SearXNG seem quite complex, which may be necessary if you are setting up a server others
+use, but not not necessary if all you want to do is run it locally.
 
 This is a tiny package to streamline running it locally, without Docker, on macOS,
-Linux, or Windows. It omits the dependencies like Apache, Nginx, and Docker and uses
-[uv](https://github.com/astral-sh/uv) to manage the Python dependencies.
-It disables features like rate limiting and Redis and runs with all default options.
+Linux, or Windows.
+
+It [uv](https://github.com/astral-sh/uv) to manage the Python dependencies, omits
+Apache, Nginx, and Docker setup, and uses the minimal template that does not enable
+features like rate limiting or Redis.
 (You can adjust these later if desired.)
 
 ## Running
@@ -25,7 +28,7 @@ uv tool install simplexng
 To run:
 
 ```shell
-simplexng 
+simplexng --open
 ```
 
 More options:
@@ -34,6 +37,9 @@ More options:
 simplexng --help
 ```
 
+As shown in the logs, it sets up a minimal config file (on macOS and Linux it will be
+`~/.config/simplexng/settings.yml`), which you can edit if desired.
+
 * * *
 
 ## Project Docs

development.md

@@ -6,8 +6,8 @@ This project is set up to use [uv](https://docs.astral.sh/uv/) to manage Python
 dependencies. First, be sure you
 [have uv installed](https://docs.astral.sh/uv/getting-started/installation/).
 
-Then [fork the jlevy/searxng-local
-repo](https://github.com/jlevy/searxng-local/fork) (having your own
+Then [fork the jlevy/simplexng
+repo](https://github.com/jlevy/simplexng/fork) (having your own
 fork will make it easier to contribute) and
 [clone it](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository).
 

pyproject.toml

@@ -1,12 +1,12 @@
 # ---- Project Info and Dependencies ----
 
 [project.urls]
-Repository = "https://github.com/jlevy/searxng-local"
+Repository = "https://github.com/jlevy/simplexng"
 # Homepage = "https://..."
 # Documentation = "https://..."
 
 [project]
-name = "searxng-local"
+name = "simplexng"
 description = "Package of SearXNG for easy local usage"
 authors = [
     { name="Joshua Levy", email="joshua@cal.berkeley.edu" },
@@ -61,11 +61,6 @@ dependencies = [
     "tomli==2.2.1 ; python_full_version < '3.11'",
     "typer-slim==0.15.4",
     "uvloop==0.21.0",
-    # XXX Needed to pull some build deps into runtime due to searxng's initialization:
-    "editables>=0.5",
-    "hatchling>=1.27.0",
-    "setuptools>=80.9.0",
-    "uv-dynamic-versioning>=0.8.2",
     # Adding waitress as the local production server:
     "waitress>=3.0.2",
     # A few CLI niceties:
@@ -74,6 +69,18 @@ dependencies = [
     "rich>=14.0.0",
 ]
 
+[project.optional-dependencies]
+# XXX Certain build dependencies are needed to initialize searxng:
+build = [   
+    "editables>=0.5",
+    "hatchling>=1.27.0",
+    "setuptools>=80.9.0",
+    "uv-dynamic-versioning>=0.8.2"
+]
+
+[tool.uv]
+# SearXNG does not work with build isolation.
+no-build-isolation-package = ["searxng"]
 
 # ---- Dev dependencies ----
 
@@ -90,13 +97,15 @@ dev = [
 
 [project.scripts]
 # Add script entry points here:
-simplexng = "searxng_local.simplexng:main"
+simplexng = "simplexng.simplexng:main"
 
 # ---- Sources ----
 
 [tool.uv.sources]
 searxng = { git = "https://github.com/searxng/searxng.git" }
 
+
+
 # ---- Build system ----
 
 # Dynamic versioning from:
@@ -119,7 +128,7 @@ bump = "true"
 
 [tool.hatch.build.targets.wheel]
 # The source location for the package.
-packages = ["src/searxng_local"]
+packages = ["src/simplexng"]
 
 
 # ---- Settings ----

src/searxng_local/__init__.py renamed to src/simplexng/__init__.py

@@ -1,11 +1,11 @@
-# SearXNG Local Settings Template
+# SimpleXNG Settings Template
 # Based on utils/templates/etc/searxng/settings.yml
 
 use_default_settings: true
 
 general:
   debug: false
-  instance_name: "SearXNG Local"
+  instance_name: "SimpleXNG"
 
 search:
   safe_search: 0