Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/ajaysathvik/drone2
Browse files Browse the repository at this point in the history
  • Loading branch information
ajaysathvik committed Jan 14, 2024
2 parents de16d18 + d1a15fc commit b8e41cd
Show file tree
Hide file tree
Showing 2 changed files with 116 additions and 1 deletion.
39 changes: 39 additions & 0 deletions .github/workflows/python-app.yml
Original file line number Diff line number Diff line change
@@ -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
78 changes: 77 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,77 @@
# drone2
# Drone-Pilot

**A simple Python project for controlling drones.**

## Installation

**Prerequisites:**

* Python 3.x (tested with 3.10)
* Google Chrome
* git

**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
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.

0 comments on commit b8e41cd

Please sign in to comment.