Skip to content

Commit

Permalink
Completed project setup phase
Browse files Browse the repository at this point in the history
  • Loading branch information
Jules Atchoglo committed Sep 23, 2024
1 parent 9a7d45d commit eb18ae9
Show file tree
Hide file tree
Showing 7 changed files with 96 additions and 3 deletions.
61 changes: 61 additions & 0 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/docker-existing-dockerfile
{
"name": "CanExplorer Container",
"build": {
// Sets the run context to one level up instead of the .devcontainer folder.
"context": "..",
// Update the 'dockerFile' property if you aren't using the standard 'Dockerfile' filename.
"dockerfile": "../Dockerfile",
"args": {
"network": "host",
"xhost": "+"
}
},
"runArgs": [
"--cap-add=SYS_PTRACE",
"--security-opt",
"seccomp=unconfined",
"--privileged",
"--network=host"
],
"appPort": [
"69:69"
],
"settings" : {
"git.path": "/usr/bin/git"
},
"mounts": [
"type=bind,source=/dev/bus/usb,target=/dev/bus/usb", // Make Debugger available.
"source=${localEnv:HOME}/.ssh,target=/home/devuser/.ssh,type=bind,consistency=cached", // Make ssh key available
"source=/tmp/.X11-unix,target=/tmp/.X11-unix,type=bind,consistency=cached" // Mount graphic inside container to run GUIs
],
"containerEnv": {
"DISPLAY": "${localEnv:DISPLAY}"
},

// Features to add to the dev container. More info: https://containers.dev/features.
// "features": {},

// Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [],

// Uncomment the next line to run commands after the container is created.
// "postCreateCommand": "cat /etc/os-release",

// Configure tool-specific properties.
// "customizations": {},

// Uncomment to connect as an existing user other than the container default. More info: https://aka.ms/dev-containers-non-root.
"remoteUser": "can_explorer",
"customizations": {
"vscode": {
"extensions": [
"ms-azuretools.vscode-docker",
"ms-python.python",
"ms-python.debugpy",
"donjayamanne.python-environment-manager"
]
}
}
}
12 changes: 12 additions & 0 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
// See https://go.microsoft.com/fwlink/?LinkId=733558
// for the documentation about the tasks.json format
"version": "2.0.0",
"tasks": [
{
"label": "echo",
"type": "shell",
"command": "echo Hello"
}
]
}
12 changes: 12 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
FROM ubuntu:noble

ENV TZ="Europe/Berlin"
RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone

RUN apt -y update
RUN apt -y install git vim python3 python3-pip pipenv

RUN apt -y update
RUN apt -y install libglib2.0-0 libglu1-mesa-dev libxkbcommon-x11-0 build-essential libgl1-mesa-dev libdbus-1-dev libxcb-*

RUN useradd -ms /bin/bash can_explorer
3 changes: 1 addition & 2 deletions Pipfile
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ name = "pypi"

[packages]
pyqt6 = "*"
pyqt6-tools = "*"
python-can = "*"
cantools = "*"
pyinstaller = "*"
Expand All @@ -21,7 +20,7 @@ pytest = "*"
pylint = "*"

[requires]
python_version = "3.10"
python_version = "3.12"

[scripts]
main = "python -m can_explorer"
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
# CANExplorer
A CANbus-Analyse Tool for all platform.


## Roadmap
1. Project Setup
- [ ] Initialize git project
- [ ] Set basic project structure
- [ ] Set package manager and install packages
- [ ] Set docker and vscode devcontainer
- [ ] Add basic working code
2.
2 changes: 1 addition & 1 deletion can_explorer/gui/main_window.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
class MainWindow(QMainWindow):
def __init__(self):
super().__init__()
loadUi("gui/qt/main_window.ui", self)
loadUi("can_explorer/gui/qt/main_window.ui", self)
Empty file added can_explorer/transport/isotp.py
Empty file.

0 comments on commit eb18ae9

Please sign in to comment.