Skip to main content

Traffic scene renderer

PyPI - Version GitHub License PyPI - Python Version Ruff Checked with mypy codecov PyPI Downloads

This traffic scene renderer enables drawing top-view overviews of traffic constellations. This drawings can be printed on screen using matplotlib and exported to images or tikz files that can be rendered with LaTeX to create vector-based drawings of the traffic scenes.

Installation

Installation can be done using pip. Simply run

pip install traffic-scene-renderer

Usage

Development

Yes, you can help! Follow the steps below to contribute to this package:

  1. Download the git repository, e.g., using git clone git@github.com:ErwindeGelder/TrafficSceneRenderer.git.

  2. Create a virtual environment, e.g., using python -m venv venv.

  3. Activate the virtual environment (e.g., on Windows, venv\Scripts\activate).

  4. Install uv using pip install uv and then tox-uv using uv pip install tox-uv.

  5. The main branch is protected, meaning that you cannot directly push changes to this branch. Therefore, if you want to make changes, do so in a seperate branch. For example, you can create a new branch using git checkout -b feature/my_awesome_new_feature.

  6. Before pushing changes, ensure that the code adheres to the linting rules and that the tests are successful. Run tox. This does a linting check and runs all test scripts. To manually perform these steps, use the following commands:

    1. Run tox -e lint. You can do the linting commands manually using:
      1. (One time) uv pip install -r requirements-lint.txt
      2. ruff format . --check (remove the --check flag to let ruff do the formatting)
      3. ruff check .
      4. mypy .
    2. Run tox -e py310.
    3. Run tox -e py311.
    4. Run tox -e py312.
    5. Run tox -e py313.
    6. Run tox -e py314.
    7. Run tox -e combine-test-reports
  7. Check if the tests covered everything using the coverage report in /reports/coverage_html/index.html.

    NOTE: Currently, not all code is covered. Ideally, all code is covered, but for now, ensure that all new code is covered by the testing.

  8. Push changes to GitHub. If everything is OK and you want to merge your changes to the main branch, create a pull request. Ideally, there is at least one reviewer who reviews the pull request before the merge.

Note that currently only "Code owners" can merge pull requests onto the main branch. This is to ensure that not everyone can break the main code (even unintentially). If you want to be a "Code owner", let us know!

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

traffic_scene_renderer-1.3.tar.gz (62.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

traffic_scene_renderer-1.3-py3-none-any.whl (59.5 kB view details)

Uploaded Python 3

File details

Details for the file traffic_scene_renderer-1.3.tar.gz.

File metadata

  • Download URL: traffic_scene_renderer-1.3.tar.gz
  • Upload date:
  • Size: 62.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for traffic_scene_renderer-1.3.tar.gz
Algorithm Hash digest
SHA256 ebfff58270638bd28cbd53cefd273b675bb332923f4060a6622c68f9650a2851
MD5 e832c94c2ab7574faa72c73393233f73
BLAKE2b-256 14467d3806ab6bc9f57fc1f5cd3ee0ae861c98b713d61d6c92eef36a1c9766e5

See more details on using hashes here.

Provenance

The following attestation bundles were made for traffic_scene_renderer-1.3.tar.gz:

Publisher: publish-to-pypi.yaml on ErwindeGelder/TrafficSceneRenderer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file traffic_scene_renderer-1.3-py3-none-any.whl.

File metadata

File hashes

Hashes for traffic_scene_renderer-1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 62891f8651b6d46ad6c3b6a9c2d4151004ae1dc31ddd39b995a0bf40c3c03f3a
MD5 f028bc66a81970327a434d575a1bf601
BLAKE2b-256 b6e60b54201dc9de3218000b5643f821c6c2e1113a9782f69a30ef9805969edb

See more details on using hashes here.

Provenance

The following attestation bundles were made for traffic_scene_renderer-1.3-py3-none-any.whl:

Publisher: publish-to-pypi.yaml on ErwindeGelder/TrafficSceneRenderer

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

1.4

2 files

This release

1.3 This release

2 files

1.2

2 files

1.1

2 files

1.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page