Skip to content

Commit

Permalink
Rename repo from bzhr -> yellowstone.
Browse files Browse the repository at this point in the history
  • Loading branch information
emmiegit committed Jan 13, 2024
1 parent 2b94b8e commit 2ace350
Show file tree
Hide file tree
Showing 8 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ WORKDIR /app

RUN pip install -r requirements.txt

CMD ["python", "-m", "bzhr", "/app/config.toml"]
CMD ["python", "-m", "yellowstone", "/app/config.toml"]
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
## bzhr — Comprehensive Backups for Wikidot
## Yellowstone — Comprehensive Backups for Wikidot

A new comprehensive backup system for Wikidot, maintained by the SCP-EN Technical Team and contributors.

Expand All @@ -18,25 +18,25 @@ Then when doing development, install the development dependencies and then run l

```bash
$ pip install -r requirements.dev.txt
$ ruff check -n bzhr # -n here and below means --no-cache
$ ruff format -n bzhr
$ mypy bzhr
$ ruff check -n yellowstone # -n here and below means --no-cache
$ ruff format -n yellowstone
$ mypy yellowstone
```

Then, to run a local instance, create a `config.toml` file (see `config.example.toml` as an example) and run:

```bash
$ python -m bzhr config.toml
$ python -m yellowstone config.toml
```

If you are packaging for a production deployment, the easiest method is to build a Docker image and ship that:

```bash
$ docker build -t scpwiki/bzhr:latest .
$ docker build -t scpwiki/yellowstone:latest .
```

### License and Naming

This software is available for use under the terms of the GNU General Public License v2 only.

The project is named for the Bright/Zartion Hominid Replicators (BZHR) from [SCP-2000](https://scpwiki.com/scp-2000), an anomaly meant to be able to "reset" the world in case of a significant K-class event. The BZHR system is the heart of SCP-2000, able to mass-manufacture humans to repopulate Earth.
The project is named for [SCP-2000](https://scpwiki.com/scp-2000), an anomaly meant to be able to "reset" the world in case of a significant K-class event. This anomaly is kept underground in Yellowstone National Park, thus the name.
File renamed without changes.
2 changes: 1 addition & 1 deletion bzhr/__main__.py → yellowstone/__main__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
Entrypoint for the BZHR Wikidot backup service.
Entrypoint for the Yellowstone Wikidot backup service.
"""

import asyncio
Expand Down
2 changes: 1 addition & 1 deletion bzhr/config.py → yellowstone/config.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ def __init__(self, path):

@staticmethod
def parse_args():
parser = ArgumentParser(description="The BZHR Wikidot backup system")
parser = ArgumentParser(description="The Yellowstone Wikidot backup system")
parser.add_argument(
"config",
help="The path to the configuration file to use",
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit 2ace350

Please sign in to comment.