# petnet-feeder-service

**Repository Path**: anuoplus/petnet-feeder-service

## Basic Information

- **Project Name**: petnet-feeder-service
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-05-09
- **Last Updated**: 2025-05-09

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# FeederNet

<img alt="Discovered devices screenshot" src="images/brand_header.png"/>

## About

![python](https://img.shields.io/badge/python-3.8%20%7C%203.9-blue)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![codecov](https://codecov.io/gh/feedernet/petnet-feeder-service/branch/master/graph/badge.svg?token=UEK2SQ7C09)](https://codecov.io/gh/feedernet/petnet-feeder-service)
[![License: MIT](https://img.shields.io/badge/license-MIT-blueviolet)](https://github.com/feedernet/petnet-feeder-service/blob/master/LICENSE)
![Docker Build](https://github.com/feedernet/petnet-feeder-service/workflows/Docker%20Build/badge.svg)
![Backend Testing/Linting](https://github.com/feedernet/petnet-feeder-service/workflows/Backend%20Testing/Linting/badge.svg)

Reverse-engineering the PetNet feeders. This project only works with V2 Feeders so far.

## Setup / Installation

Head over to the [Getting Started Wiki](https://github.com/petnet-independence-project/petnet-feeder-service/wiki/Getting-Started) for more information on spinning up your first FeederNet instance.


## Developing

You need to make sure the Python modules are available.

```
pip install poetry
poetry install
```

To run the daemon locally:

```
poetry run python -m feeder
```

If you are planning on solely developing for the backend, you can build a static version of the frontend and access the backend directly:

```
cd static
npm install
PUBLIC_URL=/build npm run build
```

Otherwise, in a different shell, run the Webpack development server:

```
npm start
```

### Linting and Code Formatting
We use Black formatting for Python and Prettier for JS, JSON, etc.

Tox will automatically run both of these tools when it runs it's normal test suite. 
If either step fails, you will need to rerun the respective formatter.

#### Black
```shell
black --target-version py38 feeder/ tests/
```

#### Prettier
```shell
cd static
npx prettier --check ./src
```

## Database and Schema Migrations

This project uses SQLAlchemy and Alembic for managing database models and schema migrations.

If you change a database model and need to generate a migration, Alembic can do that for you automatically!

```shell script
DATABASE_PATH=./data.db alembic revision --autogenerate -m "Changing something about the models."
```

This will create a migration script in `feeder/database/alembic/versions`.

To apply these changes to your database, run:

```shell script
DATABASE_PATH=./data.db alembic upgrade head
```

# How can I help?

If you have tech and coding experience, you can help! Drop Ted an email (ted@timmons.me); introduce yourself, and he'll send you a Slack invite.

**The Slack channel is _NOT_ for support requests.**

We are looking for active contributors. If you are having an issue setting up your instance or are running into what you think is a bug, please file an issue.