Skip to content

Commit

Permalink
Moved to pipx!
Browse files Browse the repository at this point in the history
  • Loading branch information
TheMariday committed Sep 3, 2024
1 parent 83d5b31 commit d96442a
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 12 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,11 @@

## Step 0: Install

`pip install "marimapper @ git+http://github.com/themariday/marimapper"`
```shell
pip install pipx
pipx ensurepath
pipx install "git+https://github.com/themariday/marimapper"
```

This will install the Marimapper library along with all the scripts needed below.

Expand Down Expand Up @@ -94,10 +98,6 @@ before running Marimapper.

</details>

To install any of the above backends, run:

`pip install "marimapper[backend_name] @ git+http://github.com/themariday/marimapper"`

If your LED backend isn't supported, you need to write your own.
Open a new python file called `my_backend.py` and copy the below stub into it.

Expand All @@ -120,6 +120,8 @@ class Backend:
# some_led_library.set_led(led_index, (0, 0, 0))
```

If your backend needs any external libraries for example, `requests`, add them to marimapper with `pipx inject marimapper requests`

Fill out the blanks and check it by running `marimapper_check_backend --backend my_backend.py`


Expand Down
10 changes: 3 additions & 7 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ dependencies = [
"tqdm",
"open3d",
"pycolmap==0.6.1",
"pyserial", # required by fcmega
"pixelblaze-client", # required by pixelblaze
"requests" # required by fcmega
]

classifiers = [
Expand Down Expand Up @@ -41,13 +44,6 @@ develop = [
"flake8-bugbear"
]

# This is where we add the backend dependencies:

fadecandy = []
fcmega = ["pyserial"]
pixelblaze = ["pixelblaze-client"]
wled = ["requests"]

[project.urls]
Homepage = "https://github.com/themariday/marimapper"
Documentation = "https://github.com/themariday/marimapper"
Expand Down

0 comments on commit d96442a

Please sign in to comment.