https://github.com/timtreis/gefslim

A minimal reader for .gef files
https://github.com/timtreis/gefslim

Last synced: 1 day ago
JSON representation

A minimal reader for .gef files

• Host: GitHub
• URL: https://github.com/timtreis/gefslim
• Owner: timtreis
• License: mit
• Created: 2023-06-26T17:56:55.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-02-22T18:44:26.000Z (11 months ago)
• Last Synced: 2024-03-25T02:48:16.071Z (10 months ago)
• Language: Python
• Size: 502 KB
• Stars: 1
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: docs/contributing.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gefslim

[![Tests][badge-tests]][link-tests]

[![Documentation][badge-docs]][link-docs]

[![Documentation][badge-pypi]][link-pypi]

[badge-tests]: https://img.shields.io/github/actions/workflow/status/timtreis/gefslim/test.yaml?branch=main

[link-tests]: https://github.com/timtreis/gefslim/actions/workflows/test.yml

[badge-docs]: https://img.shields.io/readthedocs/gefslim

[badge-pypi]: https://badge.fury.io/py/gefslim.svg

A minimal reader for .gef files

## Getting started

Please refer to the [documentation][link-docs]. In particular, the

-   [API documentation][link-api].

## Installation

You need to have Python 3.9 or newer installed on your system. If you don't have

Python installed, we recommend installing [Mambaforge](https://github.com/conda-forge/miniforge#mambaforge).

There are several alternative options to install gefslim:

1. Install the latest development version:

```bash

pip install git+https://github.com/timtreis/gefslim.git@main

```

2. Install from PyPI:

```bash

pip install gefslim

```

[scverse-discourse]: https://discourse.scverse.org/

[issue-tracker]: https://github.com/timtreis/gefslim/issues

[changelog]: https://gefslim.readthedocs.io/latest/changelog.html

[link-docs]: https://gefslim.readthedocs.io

[link-api]: https://gefslim.readthedocs.io/en/latest/generated/gefslim.GEF.html

[link-pypi]: https://pypi.org/project/gefslim/