https://github.com/farmos/farmos-aggregator

A microservice application for aggregating data from multiple farmOS instances.
https://github.com/farmos/farmos-aggregator

Last synced: about 1 year ago
JSON representation

A microservice application for aggregating data from multiple farmOS instances.

• Host: GitHub
• URL: https://github.com/farmos/farmos-aggregator
• Owner: farmOS
• License: gpl-3.0
• Created: 2019-02-24T10:54:27.000Z (over 7 years ago)
• Default Branch: 2.x
• Last Pushed: 2024-02-02T17:49:20.000Z (over 2 years ago)
• Last Synced: 2025-04-01T21:54:34.816Z (about 1 year ago)
• Language: Python
• Homepage:
• Size: 2.45 MB
• Stars: 21
• Watchers: 5
• Forks: 10
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          
# farmOS-aggregator

[![Licence](https://img.shields.io/badge/Licence-GPL%203.0-blue.svg)](https://opensource.org/licenses/GPL-3.0/)

[![Release](https://img.shields.io/github/release/farmOS/farmOS-aggregator.svg?style=flat)](https://github.com/farmOS/farmOS-aggregator/releases)

[![pipeline status](https://gitlab.com/paul.weidner/farmOS-aggregator/badges/master/pipeline.svg)](https://gitlab.com/farmOS/farmOS-aggregator/commits/master)

[![Docker](https://img.shields.io/docker/pulls/farmos/aggregator.svg)](https://hub.docker.com/r/farmos/aggregator/)

[![Last commit](https://img.shields.io/github/last-commit/farmOS/farmOS-aggregator.svg?style=flat)](https://github.com/farmOS/farmOS-aggregator/commits)

[![Chat](https://img.shields.io/matrix/farmOS:matrix.org.svg)](https://riot.im/app/#/room/#farmOS:matrix.org)



  



farmOS-aggregator is a microservice application for interacting with multiple [farmOS](https://farmOS.org)

instances. The application provides a GUI for registering farmOS instances with the Aggregator

and a REST API for interacting with farmOS instances. Depending on how an Aggregator is configured,

farmOS admins will authorize access to only a subset of their farm's data.

farmOS-aggregator is built with:

* [FastAPI](https://github.com/tiangolo/fastapi) for the REST API

* [farmOS.py](https://github.com/farmOS/farmOS.py) client library for querying farmOS instances

For more information on farmOS, visit [farmOS.org](https://farmOS.org).

## Documentation 

 - _**Using** the farmOS-aggregator_: [docs/using-farmos-aggregator.md](docs/using-farmos-aggregator.md)

 - _**Configuring** a farmOS-aggregator_: [docs/configuration.md](docs/configuration.md)

 - _**Deploying** a farmOS-aggregator_: [docs/deployment.md](docs/deployment.md)

 - _**API Documentation**_:  [docs/api.md](docs/api.md)

 - _**Development**_: [docs/development.md](docs/development.md)

## FAQ

#### _What are the motivations for creating farmOS-Aggregator?_

#### _Does this make all of my farmOS data available to the public?_

No.

#### _I have awesome farm data stored in my farmOS server! Are there any Aggregators that I can share my data with?_

## MAINTAINERS

 * Paul Weidner (paul121) - https://github.com/paul121

This project has been sponsored by:

 * [Farmier](https://farmier.com)

 * [Pennsylvania Association for Sustainable Agriculture](https://pasafarming.org)

 * [Our Sci](http://our-sci.net)

 * [Bionutrient Food Association](https://bionutrient.org)

 * [Foundation for Food and Agriculture Research](https://foundationfar.org/)