Skip to content

Commit 6481e9c

Browse files
committed
merging future branch
2 parents 636ab31 + 0a88671 commit 6481e9c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

93 files changed

+14805
-9136
lines changed

.github/CONTRIBUTING.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Contributing to the Robotics Toolbox
2+
3+
## Reporting issues
4+
5+
When reporting issues please include as much detail as possible about your
6+
operating system, roboticstoolbox version and python version. Whenever possible, please
7+
also include a brief, self-contained code example that demonstrates the problem.
8+
9+
## Contributing code
10+
11+
Thanks for your interest in contributing code!
12+
13+
We welcome all kinds of contributions including:
14+
15+
+ New features
16+
+ Bug and issue fixes
17+
+ Cleaning, adding or adding to documentation and docstrings
18+
+ Adding or fixing Python types
19+
20+
21+
Keep in mind the following when making your contribution:
22+
23+
+ Keep pull requests to a **single** feature/bug fix. This makes it much easier to review and merge. If you wish to contribure multiple different fixes or features, that means you should make multiple pull requests.
24+
25+
+ For API changes, propose the API change in the discussions first before opening a pull request.
26+
27+
+ Code additions should be formatted using [black](https://pypi.org/project/black/). Our configuration for black can be found in the [pyproject.toml](https://github.com/petercorke/robotics-toolbox-python/blob/master/pyproject.toml) file under the heading `[tool.black]`. Avoid reformatting code using other formatters.
28+
29+
+ Code addition should be linted using [flake8](https://pypi.org/project/flake8/). Our configuration for black can be found in the [pyproject.toml](https://github.com/petercorke/robotics-toolbox-python/blob/master/pyproject.toml) file under the heading `[tool.flake8]`.
30+
31+
+ Any code addition needs to be covered by unit tests and not break existing tests. Our unit tests live in `robotics-toolbox-python/tests/`. You can install the dev dependencies using the command `pip install -e '.[dev,docs]'`. You can run the test suite using the command `pytest --cov=roboticstoolbox/ --cov-report term-missing`. Check the output to make sure your additions have been covered by the unit tests.
32+
33+
+ All methods and classes need to be documented with an appropriate docstring. See our [style guide](https://github.com/petercorke/robotics-toolbox-python/wiki/Documentation-Style-Guide) for documentation. Keep the ordering and formatting as described by the style guide.
34+
35+
+ New additions should be typed appropriately. See our typing [style guide]().

.github/build-wheels.sh

Lines changed: 0 additions & 34 deletions
This file was deleted.

.github/workflows/cibuildwheel.yml

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
name: Build all Wheels
2+
3+
on:
4+
release:
5+
types: [created]
6+
workflow_dispatch:
7+
8+
jobs:
9+
build_wheels:
10+
name: Build wheels on ${{ matrix.os }}
11+
runs-on: ${{ matrix.os }}
12+
13+
strategy:
14+
matrix:
15+
os: [ubuntu-20.04, windows-2019, macos-11]
16+
include:
17+
- os: ubuntu-20.04
18+
cibw_archs: "aarch64"
19+
20+
steps:
21+
22+
# Set up emulation for arm on linux
23+
- name: Set up QEMU
24+
if: matrix.cibw_archs == 'aarch64'
25+
uses: docker/setup-qemu-action@v2
26+
with:
27+
platforms: arm64
28+
- uses: actions/checkout@v3
29+
30+
- name: Build wheels
31+
uses: pypa/cibuildwheel@v2.11.3
32+
33+
- uses: actions/upload-artifact@v3
34+
with:
35+
path: ./wheelhouse/*.whl
36+
37+
build_sdist:
38+
name: Build source distribution
39+
runs-on: ubuntu-latest
40+
steps:
41+
- uses: actions/checkout@v3
42+
43+
- name: Build sdist
44+
run: pipx run build --sdist
45+
46+
- uses: actions/upload-artifact@v3
47+
with:
48+
path: dist/*.tar.gz
49+
50+
upload_pypi:
51+
needs: [build_wheels, build_sdist]
52+
runs-on: ubuntu-latest
53+
steps:
54+
- uses: actions/download-artifact@v3
55+
with:
56+
# unpacks default artifact into dist/
57+
name: artifact
58+
path: dist
59+
60+
- uses: pypa/gh-action-pypi-publish@v1.5.0
61+
with:
62+
user: __token__
63+
password: ${{ secrets.PYPI_PASSWORD }}
64+
65+

.github/workflows/codeql_future.yml

Lines changed: 0 additions & 76 deletions
This file was deleted.

.github/workflows/python-publish.yml

Lines changed: 0 additions & 37 deletions
This file was deleted.

.github/workflows/python_publish_linux.yml

Lines changed: 0 additions & 39 deletions
This file was deleted.

.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ jobs:
4949
pytest --cov=roboticstoolbox --cov-report xml:coverage.xml
5050
coverage report
5151
- name: upload coverage to Codecov
52-
uses: codecov/codecov-action@master
52+
uses: codecov/codecov-action@v3
5353
with:
5454
file: ./coverage.xml
5555
sphinx:

.github/workflows/upload_tar.yml

Lines changed: 0 additions & 36 deletions
This file was deleted.

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.DS_Store
2+
13
.pyodide*/**
24
*.doctree
35

@@ -137,7 +139,6 @@ dmypy.json
137139
### ROS ###
138140
devel/
139141
logs/
140-
bin/
141142
msg_gen/
142143
srv_gen/
143144
msg/*Action.msg

CONTRIBUTING.md

Lines changed: 0 additions & 2 deletions
This file was deleted.

0 commit comments

Comments
 (0)