Skip to content

Commit

Permalink
Merge pull request #448 from gazebosim/merge_10_main_20241004
Browse files Browse the repository at this point in the history
Merge 10 -> main
  • Loading branch information
ahcorde authored Oct 7, 2024
2 parents 96ce11c + 698f414 commit b5357b8
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 13 deletions.
16 changes: 14 additions & 2 deletions Changelog.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,20 @@
## Gazebo Fuel Tools 10.x

### Gazebo Fuel Tools 10.0.0 (2024-09-XX)
### Gazebo Fuel Tools 10.0.0 (2024-09-25)

Changes since 9.1.0
1. **Baseline:** this includes all changes from 9.1.0 and earlier.

1. Miscellaneous documentation fixes
* [Pull request #445](https://github.com/gazebosim/gz-fuel-tools/pull/445)
* [Pull request #444](https://github.com/gazebosim/gz-fuel-tools/pull/444)
* [Pull request #443](https://github.com/gazebosim/gz-fuel-tools/pull/443)
* [Pull request #442](https://github.com/gazebosim/gz-fuel-tools/pull/442)

1. Update badges to point to gz-fuel-tools10
* [Pull request #439](https://github.com/gazebosim/gz-fuel-tools/pull/439)

1. Ionic changelog
* [Pull request #438](https://github.com/gazebosim/gz-fuel-tools/pull/438)

1. Require cmake 3.22.1
* [Pull request #436](https://github.com/gazebosim/gz-fuel-tools/pull/436)
Expand Down
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ interacting with Gazebo Fuel servers.

# Building and installing

See the [installation tutorial](https://gazebosim.org/api/fuel_tools/9/install.html).
See the [installation tutorial](https://gazebosim.org/api/fuel_tools/10/install.html).

Make sure `GZ_CONFIG_PATH` is set to the right install location so that `gz fuel` will work.
Default is `/usr/local/share/gz`.
Expand All @@ -31,7 +31,8 @@ Default is `/usr/local/share/gz`.
For a complete list of commands run `gz fuel -h` on the command line.

**List all models**
```{.sh}

```bash
$ gz fuel list -t model -r | head
https://fuel.gazebosim.org/anonymous/test_model_595389531
https://fuel.gazebosim.org/anonymous/test_model_122023392
Expand All @@ -46,7 +47,8 @@ https://fuel.gazebosim.org/anonymous/test_model_380348669
```

**Download a model**
```{.sh}

```bash
$ gz fuel download -u https://fuel.gazebosim.org/1.0/OpenRobotics/models/Ambulance -v 4
Downloading model:
Name: Ambulance
Expand Down Expand Up @@ -98,14 +100,15 @@ in.
Create a private token at
[https://app.gazebosim.org/settings#access_tokens](https://app.gazebosim.org/settings#access_tokens). Store the generated token someplace safe.
The private token can then used to upload a model:
```{.sh}
The private token can then be used to upload a model:
```bash
gz fuel upload -m ~/path_to_model --header 'Private-token: <TOKEN>'
```

## Dependencies
On ubuntu run
```{.sh}

```bash
sudo apt install ruby-ffi libzip-dev libcurl-dev libjsoncpp-dev
```

Expand Down
10 changes: 9 additions & 1 deletion src/cmd/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,15 @@ set(cmd_script_configured "${CMAKE_CURRENT_BINARY_DIR}/${CMD_NAME}${PROJECT_VERS

# Set the library_location variable to the relative path to the library file
# within the install directory structure.
set(library_location "../../../${CMAKE_INSTALL_LIBDIR}/$<TARGET_FILE_NAME:${PROJECT_LIBRARY_TARGET_NAME}>")
if (MSVC)
set(library_location_prefix "${CMAKE_INSTALL_BINDIR}")
else()
set(library_location_prefix "${CMAKE_INSTALL_LIBDIR}")
endif()

# Set the library_location variable to the relative path to the library file
# within the install directory structure.
set(library_location "../../../${library_location_prefix}/$<TARGET_FILE_NAME:${PROJECT_LIBRARY_TARGET_NAME}>")

configure_file(
"${CMD_NAME}.rb.in"
Expand Down
8 changes: 5 additions & 3 deletions tutorials/03_command_line.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,7 @@ https://fuel.gazebosim.org
By default, Fuel will list resources from all the servers listed in your
`config.yaml` file. See the \ref configuration for more details.

> **Tip**: If you want to see resources from a different Fuel server, add it to
`config.yaml` to and re-run the list command to see resources from both servers!
> **Tip**: If you want to see resources from a different Fuel server, add it to `config.yaml` to and re-run the list command to see resources from both servers!
There are a few other options on the command, run the help to see all of them:

Expand Down Expand Up @@ -123,7 +122,10 @@ sub-command. You can access the list of edit options using:
gz fuel edit -h
```

You must be the resource owner, or an authorized member of the organization that owns the resource, in order to edit the resource. This in turn means you must use the `--header 'Private-token: YOUR_TOKEN'` option with the `edit` sub-command.
You must be the resource owner, or an authorized member of the organization that owns the resource, in order to edit the resource. This in turn means you must use the next option with the `edit` subcommand:
```
--header 'Private-token: YOUR_TOKEN'
```

### Change resource privacy

Expand Down
8 changes: 7 additions & 1 deletion tutorials/04_cpp_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,12 @@ this tutorial:
mkdir /tmp/fuel_tutorial && cd /tmp/fuel_tutorial
```

Install compilation prerequisites:

```bash
sudo apt-get install libgflags-dev
```

Download the files `list.cc`, `details.cc`, `download.cc`,
`CMakeLists.txt`, and save them under `/tmp/fuel_tutorial`:

Expand Down Expand Up @@ -172,7 +178,7 @@ for (const auto &server : client.Config().Servers())
id.SetServer(server);

gz::fuel_tools::ModelIdentifier model;
if (!client.ModelDetails(server, id, model))
if (!client.ModelDetails(id, model))
continue;

std::cout << model.AsPrettyString() << std::endl;
Expand Down

0 comments on commit b5357b8

Please sign in to comment.