From f7337985232f2c0e168f23ef8b7c115f988c9a36 Mon Sep 17 00:00:00 2001 From: ajay sathvik <111119810+ajaysathvik@users.noreply.github.com> Date: Sun, 14 Jan 2024 15:14:59 +0530 Subject: [PATCH 1/3] Update README.md --- README.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index f5db51a..b81a333 100644 --- a/README.md +++ b/README.md @@ -1 +1,34 @@ -# drone2 +# Drone-Pilot + +**A simple Python project for controlling drones.** + +## Installation + +**Prerequisites:** + +* Python 3.x (tested with 3.10) +* Google Chrome + +**Steps:** + +1. **Clone the repository:** + +```bash +git clone https://github.com/ajaysathvik/drone2 +``` +2. **Create a virtual environment (recommended) :** +```bash +python -m venv drone +source drone/bin/activate # Linux/macOS +drone\Scripts\activate.bat # Windows +``` + +3. **Install dependencies:** +```bash +pip install -r requirements.txt +``` + +## Usage +```bash +python drone.py +``` From f9b6e618979df134f438c7fbfcdbb3f7be09ea01 Mon Sep 17 00:00:00 2001 From: ajay sathvik <111119810+ajaysathvik@users.noreply.github.com> Date: Sun, 14 Jan 2024 15:29:28 +0530 Subject: [PATCH 2/3] Update README.md --- README.md | 45 ++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 44 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b81a333..fb107ed 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ * Python 3.x (tested with 3.10) * Google Chrome +* git **Steps:** @@ -30,5 +31,47 @@ pip install -r requirements.txt ## Usage ```bash -python drone.py +python3 drone.py ``` + +## Contributing + +Thank you for considering contributing to our project! Follow these steps to contribute: + +1. **Fork the repository :** + Click on the "Fork" button on the top right of the repository's page to create your own copy of the project. + +2. **Clone your fork:** + +```bash +git clone https://github.com/your-username/your-drone-project.git +cd your-drone-project +``` + +3. **Create a new branch:** +```bash +git checkout -b feature/new-feature +``` + +4.**Make your changes :** +Make the necessary changes in your branch. Ensure that your changes follow the project's coding style and conventions. + +5.**Commit your changes:** +```bash +git commit -m 'Add new feature' +``` + +6.**Push to your branch:** +```bash +git push origin feature/new-feature +``` + +7. **Submit a pull request :** + Navigate to the original repository. +You should see a "Compare & pull request" button. Click on it. +Provide a brief description of your changes and submit the pull request. + +**Our team will review your contribution, and if everything looks good, we'll merge it. Thank you for your contribution!** + +## Code of Conduct +Please adhere to the project's code of conduct. Respect others' opinions and maintain a positive and inclusive environment. From d1a15fc81b819731dbe6a9786f59ea66854c80e4 Mon Sep 17 00:00:00 2001 From: ajay sathvik <111119810+ajaysathvik@users.noreply.github.com> Date: Sun, 14 Jan 2024 15:43:29 +0530 Subject: [PATCH 3/3] Create python-app.yml --- .github/workflows/python-app.yml | 39 ++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 .github/workflows/python-app.yml diff --git a/.github/workflows/python-app.yml b/.github/workflows/python-app.yml new file mode 100644 index 0000000..db5e8b0 --- /dev/null +++ b/.github/workflows/python-app.yml @@ -0,0 +1,39 @@ +# This workflow will install Python dependencies, run tests and lint with a single version of Python +# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python + +name: Drone + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +permissions: + contents: read + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + - name: Set up Python 3.10 + uses: actions/setup-python@v3 + with: + python-version: "3.10" + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install flake8 pytest + if [ -f requirements.txt ]; then pip install -r requirements.txt; fi + - name: Lint with flake8 + run: | + # stop the build if there are Python syntax errors or undefined names + flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics + # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide + flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics + - name: Test with pytest + run: | + pytest