Configuration of project structure

.github/workflows/ci.yaml

@@ -0,0 +1,22 @@
+name: CI
+on: [push]
+jobs:
+ lint:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ - name: install dependencies
+ run: |
+ sudo apt-get update && sudo apt-get install python3-pip && python3 -m pip install -r requirements.txt
+ - run: python3 -m black --diff --check $(git ls-files '*.py')
+ - run: python3 -m pylint --disable=all --enable=unused-import $(git ls-files '*.py')
+ tests:
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v3
+ - name: install dependencies
+ run: |
+ sudo apt-get update && sudo apt-get install python3-pip && python3 -m pip install -r requirements.txt
+ - name: test
+ run: |
+ python3 -m unittest discover tests/

.gitignore

@@ -0,0 +1,2 @@
+.idea
+venv

Makefile

@@ -0,0 +1,23 @@
+VENV=venv
+PYTHON=$(VENV)/bin/python3
+FILES=$(shell git ls-files '*.py')
+
+build: requirements.txt
+ @if [ ! -d $(VENV) ]; then virtualenv -p python3 $(VENV); fi
+ @$(PYTHON) -m pip install -r requirements.txt;
+
+format:
+ @$(PYTHON) -m black .
+
+run:
+ @$(PYTHON) src/main.py
+
+test:
+ @$(PYTHON) -m unittest discover tests/
+
+lint:
+ @$(PYTHON) -m black --diff --check $(FILES)
+ @$(PYTHON) -m pylint --disable=all --enable=unused-import $(FILES)
+
+clean:
+ rm -rf .mypy_cache

README.md

@@ -0,0 +1,88 @@
+<!-- PROJECT SHIELDS -->
+<!--
+*** I'm using markdown "reference style" links for readability.
+*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
+*** See the bottom of this document for the declaration of the reference variables
+*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
+*** https://www.markdownguide.org/basic-syntax/#reference-style-links
+-->
+
+[![CI][ci-shield]][ci-url]
+
+<!-- PROJECT LOGO -->
+<br />
+<p align="center">
+ <a href="https://github.com/lukaszmichalskii/camera-perception">
+ <img src="docs/resources/logo.png" alt="Logo" width="127" height="154">
+ </a>
+
+ <h3 align="center">Camera Perception</h3>
+
+ <p align="center">
+ Cones detection module based on YOLOv8 algorithm
+ <br />
+ <a href="https://github.com/lukaszmichalskii/camera-perception"><strong>Explore the docs »</strong></a>
+ <br />
+ <br />
+ <a href="https://github.com/lukaszmichalskii/camera-perception">View Demo</a>
+ ·
+ <a href="https://github.com/lukaszmichalskii/camera-perception/issues">Report Bug</a>
+ ·
+ <a href="https://github.com/lukaszmichalskii/camera-perception/issues">Request Feature</a>
+ </p>
+</p>
+
+
+
+<!-- TABLE OF CONTENTS -->
+## Table of Contents
+
+* [About the Project](#about-the-project)
+* [Backlog](#backlog)
+* [Contact](#contact)
+
+
+
+<!-- ABOUT THE PROJECT -->
+## About The Project
+
+Cones detection algorithm used in the camera vision system
+of an autonomous formula of the PWr Racing Team, participating in the Formula Student Driverless
+competition. Formula Student Driverless is a worldwide university competition, each year teams compete
+in building an autonomous formula. The project is proof of concept of cones detection module for
+the currently developed perception system. The positions of the cones seen through the camera are then
+used by the car’s autonomous system to drive.
+
+<!-- BACKLOG -->
+## Backlog
+
+See the [Issues](https://github.com/lukaszmichalskii/camera-perception/issues) for a list of proposed features (and known issues).
+
+
+<!-- CONTACT -->
+## Contact
+
+Project: [https://github.com/lukaszmichalskii/camera-perception](https://github.com/lukaszmichalskii/camera-perception)
+
+| Author | Email |
+|--------------|--------------|
+| Łukasz Michalski | 261118@student.pwr.edu.pl |
+| Andrzej Sołtysik | 259191@student.pwr.edu.pl |
+
+
+<!-- MARKDOWN LINKS & IMAGES -->
+<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
+[contributors-shield]: https://img.shields.io/github/contributors/lukaszmichalskii/repo.svg?style=flat-square
+[contributors-url]: https://github.com/lukaszmichalskii/Samsung-KPZ/graphs/contributors
+[forks-shield]: https://img.shields.io/github/forks/lukaszmichalskii/repo.svg?style=flat-square
+[forks-url]: https://github.com/lukaszmichalskii/Samsung-KPZ/network/members
+[stars-shield]: https://img.shields.io/github/stars/lukaszmichalskii/repo.svg?style=flat-square
+[stars-url]: https://github.com/lukaszmichalskii/Samsung-KPZ/stargazers
+[issues-shield]: https://img.shields.io/github/issues/lukaszmichalskii/repo.svg?style=flat-square
+[issues-url]: https://github.com/lukaszmichalskii/Samsung-KPZ/issues
+[license-shield]: https://img.shields.io/badge/license-MIT-orange
+[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=flat-square&logo=linkedin&colorB=555
+[linkedin-url]: https://www.linkedin.com/in/lukasz-michalski-823106202/
+[jira-shield]: https://img.shields.io/badge/Jira-Join-blue
+[ci-shield]: https://img.shields.io/badge/CI-passing-green
+[ci-url]: https://github.com/lukaszmichalskii/camera-perception/actions/

requirements.txt

@@ -0,0 +1,2 @@
+black~=23.3.0
+pylint~=2.17.2

src/camera-perception/__init__.py

@@ -0,0 +1,5 @@
+# Copyright (C) 2023 PWR Racing Team & Wroclaw University of Science and Technology
+# Author: Łukasz Michalski <261118@student.pwr.edu.pl>
+# Andrzej Sołtysik <259191@student.pwr.edu.pl>
+# URL: <https://github.com/lukaszmichalskii/camera-perception>
+#

src/main.py

@@ -0,0 +1,2 @@
+if __name__ == "__main__":
+ pass

tests/test_main.py

@@ -0,0 +1,6 @@
+import unittest
+
+
+class TestMain(unittest.TestCase):
+ def test_main(self):
+ self.assertTrue(True)