Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PyPI examples] Manage Drake version consistently #375

Merged
merged 5 commits into from
Mar 5, 2025
Merged

[PyPI examples] Manage Drake version consistently #375

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
04985ca
[PyPI examples] manage Drake version consistently
tyler-yankee Feb 27, 2025
c16b82d
remove comments tying to specific Drake versions
tyler-yankee Mar 3, 2025
ba8ac9e
configure dependabot for Drake version updates
tyler-yankee Mar 3, 2025
7ac4dc6
review changes
tyler-yankee Mar 3, 2025
1384411
use environment variable for PYTHON_VERSION in GHA
tyler-yankee Mar 4, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions drake_pip/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
This installs Drake using [`pip`](https://pypi.org/project/pip/),
the Python package manager.

Currently, this example is supported using
[Drake v1.38.0](https://github.com/RobotLocomotion/drake/releases/tag/v1.38.0).

# Instructions

Follow the setup instructions for [Ubuntu](#ubuntu-setup)
Expand All @@ -19,7 +22,8 @@ If on Ubuntu, first install the required packages:
setup/install_prereqs
```

This script will also run `setup/setup_env`, which creates the virtual environment for this project and installs Drake.
This script will also run `setup/setup_env`,
which creates the virtual environment for this project and installs Drake.

To start programming, simply activate the environment by calling:

Expand All @@ -33,7 +37,8 @@ If on Mac OS X, simply ensure the correct version of Python
is installed from Homebrew by referring to the
[Supported Configurations](https://drake.mit.edu/installation.html#supported-configurations).

Then, run the following script to create the virtual environment for this project and install Drake:
Then, run the following script to create the virtual environment
for this project and install Drake:

```bash
setup/setup_env
Expand Down
6 changes: 3 additions & 3 deletions drake_pip/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Currently, this only includes the most recent version of drake.
# Feel free to add more packages for your own project!
drake
# This example is currently supported using Drake 1.38.0.
# Feel free to add more packages for your own project below!
drake>=1.38.0
17 changes: 11 additions & 6 deletions drake_poetry/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,29 @@
# Python Project with Drake Installed from Poetry

This installs Drake using [`poetry`](https://python-poetry.org/),
the Python package manager.

For an introduction to `poetry`,
the Python package manager. For an introduction to `poetry`,
see [Basic usage](https://python-poetry.org/docs/basic-usage/).

Currently, this example is supported using
[Drake v1.38.0](https://github.com/RobotLocomotion/drake/releases/tag/v1.38.0).

# Instructions

The `pyproject.toml` file found in this directory contains all
that is needed to start a Poetry project using the most recent
version of Drake.
that is needed to start a Poetry project using Drake.

First, follow the [Installation Instructions](https://python-poetry.org/docs/#installation)
to install Poetry using your preferred method.

Run the installation script to perform the following:

* install the required system packages for Drake (Ubuntu only)
* set up your Poetry environment and install the most recent version of Drake
* set up your Poetry environment and install Drake
- The `poetry.lock` file listing all dependencies and their versions is not
included with this example in order to reduce confusion and keep the version
of Drake up to date. It will be created once the environment is set up,
and it's encouraged to check in this file for your own project
using Drake in order to manage its dependencies.

```bash
setup/install_prereqs
Expand Down
Loading
Loading