pyFRI -> pyfri

lbr-stack · Sep 7, 2024 · 81ebd7a · 81ebd7a
1 parent acb3ce0
commit 81ebd7a
Show file tree

Hide file tree

Showing 18 changed files with 33 additions and 31 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -3,18 +3,18 @@ The [LBR-Stack](https://github.com/lbr-stack/) thrives to build a friendly commu
 We **encourage** everyone to open issues for questions / problems / features. For additional information, we would like to provide some links below.
 
 ### Knowledge Sources
-- [Open issues](https://github.com/lbr-stack/pyFRI/issues)
-- [Closed issues](https://github.com/lbr-stack/pyFRI/issues?q=is%3Aissue+is%3Aclosed)
+- [Open issues](https://github.com/lbr-stack/pyfri/issues)
+- [Closed issues](https://github.com/lbr-stack/pyfri/issues?q=is%3Aissue+is%3Aclosed)
 
 ## Contributing
-### pyFRI
+### pyfri
 Contributions are vital to this project. If you want to contribute a feature / fix proceed as follows
 
 1. Open an issue:
   - Explain the issue and your solution
   - Request a new branch: `dev-feature`, e.g. `dev-my-new-demo`
 2. Fork this repository
-3. Create a [pull request](https://github.com/lbr-stack/pyFRI/pulls) against `dev-<feature>`
+3. Create a [pull request](https://github.com/lbr-stack/pyfri/pulls) against `dev-<feature>`
 
 ### New FRI version
 Refer [README](https://github.com/lbr-stack/fri#contributing) for instructions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -5,7 +5,7 @@
 
 cmake_minimum_required(VERSION 3.16.3)
 
-project(_pyFRI)
+project(_pyfri)
 
 include(FetchContent)
 
@@ -27,12 +27,12 @@ FetchContent_MakeAvailable(FRI)
 
 add_subdirectory(pybind)
 
-pybind11_add_module(_pyFRI ${CMAKE_CURRENT_SOURCE_DIR}/pyFRI/src/wrapper.cpp)
+pybind11_add_module(_pyfri ${CMAKE_CURRENT_SOURCE_DIR}/pyfri/src/wrapper.cpp)
 
 target_include_directories(
-    _pyFRI
+    _pyfri
     PRIVATE
-    ${CMAKE_CURRENT_SOURCE_DIR}/pyFRI/src
+    ${CMAKE_CURRENT_SOURCE_DIR}/pyfri/src
 )
 
-target_link_libraries(_pyFRI PRIVATE FRIClient)
+target_link_libraries(_pyfri PRIVATE FRIClient)
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -60,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-https://github.com/lbr-stack/pyFRI/issues.
+https://github.com/lbr-stack/pyfri/issues.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
-# pyFRI
+# pyfri
 
-[![Build](https://github.com/lbr-stack/pyFRI/actions/workflows/build.yaml/badge.svg)](https://github.com/lbr-stack/pyFRI/actions/workflows/build.yaml)
-[![License](https://img.shields.io/github/license/lbr-stack/pyFRI)](https://github.com/lbr-stack/pyFRI/tree/main?tab=Apache-2.0-1-ov-file#readme)
+[![Build](https://github.com/lbr-stack/pyfri/actions/workflows/build.yaml/badge.svg)](https://github.com/lbr-stack/pyfri/actions/workflows/build.yaml)
+[![License](https://img.shields.io/github/license/lbr-stack/pyfri)](https://github.com/lbr-stack/pyfri/tree/main?tab=Apache-2.0-1-ov-file#readme)
 [![JOSS](https://joss.theoj.org/papers/c43c82bed833c02503dd47f2637192ef/status.svg)](https://joss.theoj.org/papers/c43c82bed833c02503dd47f2637192ef)
 [![Code Style: Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 
@@ -26,7 +26,7 @@ ClientApplication app(connection, client);
 In Python, the equivalent code is as follows.
 
 ```python
-import pyFRI as fri
+import pyfri as fri
 
 # ..setup client..
 
@@ -41,11 +41,11 @@ See the [examples](examples/).
 
 1. Clone repository (make sure you include `--recursive`):
    ```shell
-   git clone --recursive https://github.com/lbr-stack/pyFRI.git
+   git clone --recursive https://github.com/lbr-stack/pyfri.git
    ```
 2. Change directory:
    ```shell
-   cd pyFRI
+   cd pyfri
    ```
 3. Install:
    ```shell

diff --git a/doc/pyfri.rst b/doc/pyfri.rst
@@ -1,4 +1,6 @@
+pyfri
+=====
 
-## Upgrading/switching between FRI Versions
+.. ## Upgrading/switching between FRI Versions
 
-If you upgrade your FRI version or want to switch between them, you need to manually remove the `build/` directory before running `pip install`.
+.. If you upgrade your FRI version or want to switch between them, you need to manually remove the `build/` directory before running `pip install`.
diff --git a/examples/LBRJointSineOverlay.py b/examples/LBRJointSineOverlay.py
@@ -6,7 +6,7 @@
 import numpy as np
 import pandas as pd
 
-import pyFRI as fri
+import pyfri as fri
 
 
 class LBRJointSineOverlayClient(fri.LBRClient):

diff --git a/examples/LBRTorqueSineOverlay.py b/examples/LBRTorqueSineOverlay.py
@@ -4,7 +4,7 @@
 
 import numpy as np
 
-import pyFRI as fri
+import pyfri as fri
 
 
 class LBRTorqueSineOverlayClient(fri.LBRClient):

diff --git a/examples/LBRWrenchSineOverlay.py b/examples/LBRWrenchSineOverlay.py
@@ -4,7 +4,7 @@
 
 import numpy as np
 
-import pyFRI as fri
+import pyfri as fri
 
 
 class LBRWrenchSineOverlayClient(fri.LBRClient):

diff --git a/examples/hand_guide.py b/examples/hand_guide.py
@@ -4,9 +4,9 @@
 import numpy as np
 from admittance import AdmittanceController
 
-import pyFRI as fri
-from pyFRI.tools.filters import ExponentialStateFilter
-from pyFRI.tools.state_estimators import (
+import pyfri as fri
+from pyfri.tools.filters import ExponentialStateFilter
+from pyfri.tools.state_estimators import (
     FRIExternalTorqueEstimator,
     JointStateEstimator,
     WrenchEstimatorTaskOffset,

diff --git a/examples/joint_teleop.py b/examples/joint_teleop.py
@@ -4,7 +4,7 @@
 import pygame
 
 # FRI Client: https://github.com/cmower/FRI-Client-SDK_Python
-import pyFRI as fri
+import pyfri as fri
 
 pygame.init()
 

diff --git a/examples/task_teleop.py b/examples/task_teleop.py
@@ -6,7 +6,7 @@
 import pygame
 
 # FRI Client: https://github.com/cmower/FRI-Client-SDK_Python
-import pyFRI as fri
+import pyfri as fri
 
 pygame.init()
 

diff --git a/pyFRI/__init__.py b/pyFRI/__init__.py
diff --git a/pyfri/__init__.py b/pyfri/__init__.py
@@ -0,0 +1 @@
+from _pyfri import *
diff --git a/pyFRI/src/wrapper.cpp → pyfri/src/wrapper.cpp b/pyFRI/src/wrapper.cpp → pyfri/src/wrapper.cpp
@@ -199,7 +199,7 @@ class PyClientApplication {
 // Python bindings
 namespace py = pybind11;
 
-PYBIND11_MODULE(_pyFRI, m) {
+PYBIND11_MODULE(_pyfri, m) {
   m.doc() = "Python bindings for the KUKA FRI Client SDK. THIS IS NOT A KUKA "
             "PRODUCT.";
 

diff --git a/pyFRI/tools/__init__.py → pyfri/tools/__init__.py b/pyFRI/tools/__init__.py → pyfri/tools/__init__.py
diff --git a/pyFRI/tools/filters.py → pyfri/tools/filters.py b/pyFRI/tools/filters.py → pyfri/tools/filters.py
diff --git a/pyFRI/tools/state_estimators.py → pyfri/tools/state_estimators.py b/pyFRI/tools/state_estimators.py → pyfri/tools/state_estimators.py
@@ -1,6 +1,6 @@
 import abc
 import numpy as np
-from pyFRI import LBRState
+from pyfri import LBRState
 from collections import deque
 
 

diff --git a/setup.py b/setup.py
@@ -142,14 +142,14 @@ def build_extension(self, ext: CMakeExtension) -> None:
 
 
 setup(
-    name="pyFRI",
+    name="pyfri",
     version="1.2.0",
     author="Christopher E. Mower, Martin Huber",
     author_email="[email protected], [email protected]",
     description="Python bindings for the FRI Client SDK library.",
     long_description="",
     packages=find_packages(),
-    ext_modules=[CMakeExtension("_pyFRI")],
+    ext_modules=[CMakeExtension("_pyfri")],
     install_requires=["numpy", "pygame", "pyoptas", "pandas", "matplotlib"],
     cmdclass={"build_ext": CMakeBuild},
     python_requires=">=3.8",