diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 1c0beb9..6c3c3a3 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -20,7 +20,7 @@ jobs: # We don't need to run on all platforms since this package is # platform-agnostic. The output wheel is something like - # "kbrain--py3-none-any.whl". + # "kos--py3-none-any.whl". runs-on: ubuntu-latest steps: diff --git a/Cargo.toml b/Cargo.toml index 195241d..3c6f5ce 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,8 +1,8 @@ [workspace] members = [ - "kbrain/bindings", - "kbrain/rust", + "kos/bindings", + "kos/rust", ] resolver = "2" @@ -12,7 +12,7 @@ version = "0.1.0" authors = ["Wesley Maa ", "Pawel Budzianowski ", "Benjamin Bolte "] edition = "2021" license = "MIT" -repository = "https://github.com/kscalelabs/kbrain" -description = "The brain for K-Scale's humanoid robots" +repository = "https://github.com/kscalelabs/kos" +description = "The K-Scale Operating System" documentation = "https://docs.kscale.dev/software/actuators/overview" readme = "README.md" diff --git a/MANIFEST.in b/MANIFEST.in index 4875cb1..aefc580 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1 +1 @@ -recursive-include kbrain/ *.py *.txt py.typed MANIFEST.in +recursive-include kos/ *.py *.txt py.typed MANIFEST.in diff --git a/Makefile b/Makefile index 77077ef..a5f94f5 100644 --- a/Makefile +++ b/Makefile @@ -1,12 +1,12 @@ # Makefile define HELP_MESSAGE -k-brain +kos # Installing -1. Create a new Conda environment: `conda create --name k-brain python=3.11` -2. Activate the environment: `conda activate k-brain` +1. Create a new Conda environment: `conda create --name kos python=3.11` +2. Activate the environment: `conda activate kos` 3. Install the package: `make install-dev` # Running Tests diff --git a/README.md b/README.md index 306e57d..6bd469f 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,3 @@ -# k-brain +# kOS -Welcome to the k-brain project! +Welcome to the K-Scale Operating System! diff --git a/kbrain/__init__.py b/kos/__init__.py similarity index 100% rename from kbrain/__init__.py rename to kos/__init__.py diff --git a/kbrain/bindings/Cargo.toml b/kos/bindings/Cargo.toml similarity index 100% rename from kbrain/bindings/Cargo.toml rename to kos/bindings/Cargo.toml diff --git a/kbrain/bindings/src/bin.rs b/kos/bindings/src/bin.rs similarity index 100% rename from kbrain/bindings/src/bin.rs rename to kos/bindings/src/bin.rs diff --git a/kbrain/bindings/src/lib.rs b/kos/bindings/src/lib.rs similarity index 100% rename from kbrain/bindings/src/lib.rs rename to kos/bindings/src/lib.rs diff --git a/kbrain/py.typed b/kos/py.typed similarity index 100% rename from kbrain/py.typed rename to kos/py.typed diff --git a/kbrain/requirements-dev.txt b/kos/requirements-dev.txt similarity index 100% rename from kbrain/requirements-dev.txt rename to kos/requirements-dev.txt diff --git a/kbrain/requirements.txt b/kos/requirements.txt similarity index 100% rename from kbrain/requirements.txt rename to kos/requirements.txt diff --git a/kbrain/rust/Cargo.toml b/kos/rust/Cargo.toml similarity index 100% rename from kbrain/rust/Cargo.toml rename to kos/rust/Cargo.toml diff --git a/kbrain/rust/src/bin.rs b/kos/rust/src/bin.rs similarity index 100% rename from kbrain/rust/src/bin.rs rename to kos/rust/src/bin.rs diff --git a/kbrain/rust/src/lib.rs b/kos/rust/src/lib.rs similarity index 100% rename from kbrain/rust/src/lib.rs rename to kos/rust/src/lib.rs diff --git a/pyproject.toml b/pyproject.toml index 0c590c8..aca9152 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -64,7 +64,7 @@ dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$" [tool.ruff.lint.isort] -known-first-party = ["kbrain", "tests"] +known-first-party = ["kos", "tests"] combine-as-imports = true [tool.ruff.lint.pydocstyle] diff --git a/setup.py b/setup.py index af3ce38..2b50820 100644 --- a/setup.py +++ b/setup.py @@ -13,17 +13,17 @@ long_description: str = f.read() -with open("kbrain/requirements.txt", "r", encoding="utf-8") as f: +with open("kos/requirements.txt", "r", encoding="utf-8") as f: requirements: list[str] = f.read().splitlines() -with open("kbrain/requirements-dev.txt", "r", encoding="utf-8") as f: +with open("kos/requirements-dev.txt", "r", encoding="utf-8") as f: requirements_dev: list[str] = f.read().splitlines() -with open("kbrain/__init__.py", "r", encoding="utf-8") as fh: +with open("kos/__init__.py", "r", encoding="utf-8") as fh: version_re = re.search(r"^__version__ = \"([^\"]*)\"", fh.read(), re.MULTILINE) -assert version_re is not None, "Could not find version in kbrain/__init__.py" +assert version_re is not None, "Could not find version in kos/__init__.py" version: str = version_re.group(1) @@ -36,15 +36,15 @@ def run(self) -> None: setup( - name="k-brain", + name="kos", version=version, - description="The k-brain project", + description="The K-Scale Operating System", author="Benjamin Bolte", - url="https://github.com/kscalelabs/kbrain", + url="https://github.com/kscalelabs/kos", rust_extensions=[ RustExtension( - target="actuator.bindings", - path="actuator/bindings/Cargo.toml", + target="kos.bindings", + path="kos/bindings/Cargo.toml", binding=Binding.PyO3, ), ], @@ -55,6 +55,6 @@ def run(self) -> None: install_requires=requirements, tests_require=requirements_dev, extras_require={"dev": requirements_dev}, - packages=find_packages(include=["actuator"]), + packages=find_packages(include=["kos"]), cmdclass={"build_ext": RustBuildExt}, )