Skip to content

Commit 5e03764

Browse files
Merge pull request #368 from neurobionics/release/3.0.0
Minor updates to README and pyproject.toml
2 parents adc9ea3 + d2515ce commit 5e03764

File tree

3 files changed

+17
-17
lines changed

3 files changed

+17
-17
lines changed

README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@
1313

1414
An open-source SDK for developing and testing algorithms on commonly used robotic hardware. Originally developed for the [Open-Source Leg](https://www.opensourceleg.org/) project, this library provides a comprehensive framework for interfacing with various actuators and sensors in robotic systems. While initially designed for prosthetic leg applications, the `opensourceleg` library's modular architecture makes it versatile for use with any robotic platform utilizing similar components.
1515

16-
> We are currently testing the new version of the library (main branch), and the PyPI release will be updated soon. If you are looking for the source behind the existing PyPI release, please refer to the [legacy branch](https://github.com/neurobionics/opensourceleg/tree/legacy).
17-
1816
<img src="https://raw.githubusercontent.com/neurobionics/opensourceleg/refs/heads/main/assets/images/banner.gif" width="800" title="Open-Source Leg">
1917

2018
## 🎯 Key Features
@@ -51,9 +49,11 @@ The library currently supports the following hardware components:
5149
| Moteus | ⚠️ | ⚠️ | ⚠️ ||
5250
| TMotor || ⚠️ |||
5351

54-
> Legend: ✅ Complete/Available; ⚠️ Partial/In Progress; ❌ Not Yet Available
52+
> Legend: ✅ Complete/Available; ⚠️ Partial/In Progress; ❌ Not Yet Available;
5553
56-
> Hardware tests indicate successful testing on physical devices. Benchmarks include performance metrics such as response time and accuracy measurements. Documentation includes API reference and usage examples.
54+
Hardware tests indicate successful testing on physical devices.
55+
Benchmarks include performance metrics such as response time and accuracy measurements.
56+
Documentation includes API reference and usage examples.
5757

5858
## 📦 Installation
5959

docs/index.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@
1313

1414
An open-source SDK for developing and testing algorithms on commonly used robotic hardware. Originally developed for the [Open-Source Leg](https://www.opensourceleg.org/) project, this library provides a comprehensive framework for interfacing with various actuators and sensors in robotic systems. While initially designed for prosthetic leg applications, the `opensourceleg` library's modular architecture makes it versatile for use with any robotic platform utilizing similar components.
1515

16-
> We are currently testing the new version of the library (main branch), and the PyPI release will be updated soon. If you are looking for the source behind the existing PyPI release, please refer to the [legacy branch](https://github.com/neurobionics/opensourceleg/tree/legacy).
17-
1816
<img src="https://raw.githubusercontent.com/neurobionics/opensourceleg/refs/heads/main/assets/images/banner.gif" width="800" title="Open-Source Leg">
1917

2018
## 🎯 Key Features
@@ -51,9 +49,11 @@ The library currently supports the following hardware components:
5149
| Moteus | ⚠️ | ⚠️ | ⚠️ ||
5250
| TMotor || ⚠️ |||
5351

54-
> Legend: ✅ Complete/Available; ⚠️ Partial/In Progress; ❌ Not Yet Available
52+
> Legend: ✅ Complete/Available; ⚠️ Partial/In Progress; ❌ Not Yet Available;
5553
56-
> Hardware tests indicate successful testing on physical devices. Benchmarks include performance metrics such as response time and accuracy measurements. Documentation includes API reference and usage examples.
54+
Hardware tests indicate successful testing on physical devices.
55+
Benchmarks include performance metrics such as response time and accuracy measurements.
56+
Documentation includes API reference and usage examples.
5757

5858
## 📦 Installation
5959

pyproject.toml

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[tool.poetry]
22
name = "opensourceleg"
33
version = "3.0.0"
4-
description = "An open-source software library for numerical computation, data acquisition, and control of lower-limb robotic prostheses."
4+
description = "An open-source SDK for developing and testing algorithms on commonly used robotic hardware."
55
authors = ["Open-Source Leg <[email protected]>"]
66
repository = "https://github.com/neurobionics/opensourceleg"
77
documentation = "https://neurobionics.github.io/opensourceleg/"
@@ -54,14 +54,14 @@ build-backend = "poetry.core.masonry.api"
5454
[tool.mypy]
5555
files = ["opensourceleg"]
5656
exclude = ["opensourceleg/actuators/moteus.py", "opensourceleg/actuators/tmotor.py"]
57-
ignore_missing_imports = "True"
58-
disallow_untyped_defs = "True"
59-
disallow_any_unimported = "True"
60-
no_implicit_optional = "True"
61-
check_untyped_defs = "True"
62-
warn_return_any = "True"
63-
warn_unused_ignores = "True"
64-
show_error_codes = "True"
57+
ignore_missing_imports = true
58+
disallow_untyped_defs = true
59+
disallow_any_unimported = true
60+
no_implicit_optional = true
61+
check_untyped_defs = true
62+
warn_return_any = true
63+
warn_unused_ignores = true
64+
show_error_codes = true
6565

6666

6767
[tool.pytest.ini_options]

0 commit comments

Comments
 (0)