Skip to content

Update install in readme me to use uv #63

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

Closed
aleksander-ferkingstad wants to merge 1 commit into from
Closed

Update install in readme me to use uv #63

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 8 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,20 +22,12 @@ reading and writing OD files in `.json`/`.jsonc` format, in legacy XML `.od`
and `.eds` files. It can generate c code for use with the canfestival library.


## Install
## Install
see confluence [page](https://laerdal.atlassian.net/wiki/spaces/LEVO/pages/1163330546/Setting+up+and+using+Python) on setting up python. The instructions below expect that you have set up the package repos.

@sveinse sveinse Oct 22, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an open-source tool, so we cannot refer to any company internal repos


To install into a virtual environment `venv`. Check out this repo and go to
the top in a command-prompt (here assuming Windows and git bash):

$ py -3 -mvenv venv
$ venv/Scripts/python -mpip install --upgrade pip setuptools # Optional
$ venv/Scripts/pip install objdictgen[ui] # [ui] will install GUI tools

After this `venv/Scripts/odg.exe` (on Windows) will exist and can be called
from anywhere to run it.

The `[ui]` suffix to `pip install` will install the wx dependency needed
for the UI `odg edit`. If no UI is needed, this suffix can be omitted.
```
uv tool install --python 3.11 objdictgen --with wxPython
```

## `odg` command-line tool

Expand All @@ -62,6 +54,9 @@ The legacy commands `objdictgen` and `objdictedit` are no longer available. The
commands are available under `odg gen` and `odg edit` respectively.





Comment on lines +57 to +59

@sveinse sveinse Oct 22, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove

## JSON schema

[src/objdictgen/schema/od.schema.json](src/objdictgen/schema/od.schema.json)
Expand Down
Loading