File: README.md

package info (click to toggle)
pytraccar 3.0.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 456 kB
  • sloc: python: 786; makefile: 3
file content (28 lines) | stat: -rw-r--r-- 908 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# [pytraccar](https://pypi.org/project/pytraccar/)

[![codecov](https://codecov.io/gh/ludeeus/pytraccar/branch/main/graph/badge.svg)](https://codecov.io/gh/ludeeus/pytraccar)
![python version](https://img.shields.io/badge/Python-3.13-indigo.svg)
[![PyPI](https://img.shields.io/pypi/v/pytraccar)](https://pypi.org/project/pytraccar)


## Installation

```bash
python3 -m install pytraccar
```

Look at the file `example.py` for a usage example.


## Contribute

**All** contributions are welcome!

1. Fork the repository
2. Clone the repository locally and open the devcontainer or use GitHub codespaces
3. Do your changes
4. Lint the files with `poetry run ruff check --fix pytraccar`
5. Format the files with `poetry run ruff format`
6. Ensure all tests passes and coverage is still at 100% with `poetry run pytest --cov`
7. Commit your work, and push it to GitHub
8. Create a PR against the `main` branch