https://github.com/badgerloop-software/file_sync
https://github.com/badgerloop-software/file_sync
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/badgerloop-software/file_sync
- Owner: badgerloop-software
- Created: 2023-10-29T17:33:19.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-17T17:38:22.000Z (about 2 years ago)
- Last Synced: 2024-05-17T18:48:28.017Z (about 2 years ago)
- Language: Python
- Size: 25.4 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Driver IO to Engineering Dashboard File Sync Utility
This program synchronizes files generated by a [driver IO](https://github.com/badgerloop-software/sc1-driver-io) background process with a server, and from the server onto the machine running the [engineering dashboard](https://github.com/badgerloop-software/chase-car-dashboard).
## Libraries
* [requests](https://docs.python-requests.org/en/latest/index.html): Library for HTTP; used on all components
* [FastAPI](https://fastapi.tiangolo.com): Library for building APIs; used on server only
* [Uvicorn](https://www.uvicorn.org): Web server; used on server only
* [Pydantic](https://docs.pydantic.dev/latest/): Library for data validation and type checking; currently used on server only
## Running & Contributing
1. Use [pip to install libraries](https://docs.python.org/3/installing/index.html). If you prefer, you may also use [virtualenv](https://virtualenv.pypa.io/en/latest/user_guide.html) to isolate this project's dependencies from other Python packages on your computer.
2. Run the main.py files in each of the top-level directories of this repository. You can run all three components on your computer at the same time if you want to test the system end to end.