Skip to content

Commit

Permalink
Remove example usage and custom tasks sections from README
Browse files Browse the repository at this point in the history
  • Loading branch information
pesnik committed Jan 18, 2025
1 parent e8cb8db commit 8003107
Showing 1 changed file with 0 additions and 35 deletions.
35 changes: 0 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,41 +123,6 @@ Run the following commands from the root of the project:
| `invoke dev.lint` | Lint the code using `flake8` and `mypy`. |
| `invoke dev.test` | Run all tests with `pytest`. |

### Example Usage

```bash
# Set up the development environment
invoke dev.setup

# Format the code
invoke dev.format

# Lint the code
invoke dev.lint

# Run tests
invoke dev.test
```

### Adding Custom Tasks

You can add custom tasks by creating new Python files in the `tasks/` folder. For example, to add a task for running a specific test file:

```python
# tasks/test.py
from invoke import task

@task
def unit(c):
"""Run unit tests."""
c.run("pytest tests/unit/")
```

Then, run the task with:
```bash
invoke test.unit
```

## 🧪 Testing

```bash
Expand Down

0 comments on commit 8003107

Please sign in to comment.