Metadata-Version: 2.1
Name: farmtool
Version: 1.0.1
Summary: Farmtool to help the farmer to automate and handle Cowsheds.
Author: Bishara
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: certifi (>=2023.11.17,<2024.0.0)
Requires-Dist: cron-validator (>=1.0.8,<2.0.0)
Requires-Dist: datetime (>=5.3,<6.0)
Requires-Dist: fastapi (>=0.104.1,<0.105.0)
Requires-Dist: httpx (>=0.25.2,<0.26.0)
Requires-Dist: motor (>=3.3.2,<4.0.0)
Requires-Dist: requests (>=2.31.0,<3.0.0)
Requires-Dist: unitest (>=1.4.34,<2.0.0)
Requires-Dist: uvicorn (>=0.24.0.post1,<0.25.0)
Description-Content-Type: text/markdown

# Farmtool

Farmtool to help the farmer to automate and handle Cowsheds.

## Installation

Use the package manager to install poetry() to install all the needed dependencies for the project.

```bash
pip install poetry
```

Use poetry package to install all dependencies for the project.

```bash
poetry install
```

## Execute code and tests

***This step should be only executed after the installation is finished.***

* connect to the project environment.

```bash
poetry shell
```
and then you can run the code or test it using the following commands.

###  Run code


```bash
uvicorn farmtool.main:app --reload
```
After running the code, a session will be opened in the following [URL](http://127.0.0.1:8000)

#### - Recomendation: 

Use [docs](http://127.0.0.1:8000/docs) to load the swaggerUI to test endpoints seamlessly.

###  Test code

```bash
pytest
```


## Try it out:

A publicly deployed and running version of the farmtool is available on azure.

check it out: [farmtool](https://farmtool-aca-app.blackglacier-5fa52807.germanywestcentral.azurecontainerapps.io/)

