create package

Author: gabrielburnworth

.gitignore

@@ -2,3 +2,4 @@
 .DS_Store
 __pycache__
 py_venv
+dist

README.md

@@ -30,40 +30,30 @@ This library provides authentication, API, and control utilities for **FarmBot s
 * [Developer Info](#toolbox-developer-info)
     * [Formatting message broker messages](#formatting-message-broker-messages)
 
-## :computer: Installation (Mac OS)
+## :computer: Installation
 
-To set up the project locally, follow these steps:
+To use the sidecar starter pack, follow these steps:
 
-(1) Clone the repository.
-```bash
-git clone https://github.com/FarmBot-Labs/sidecar-starter-pack
-```
-
-(2) Navigate to the project directory.
-```bash
-cd sidecar-starter-pack
-```
-
-(3) Create a virtual environment.
+(1) Create a virtual environment.
 ```bash
 python -m venv py_venv
 ```
 
-(4) Activate the virtual environment.
+(2) Activate the virtual environment.
 ```bash
 source py_venv/bin/activate
 ```
 
-(5) Install the required libraries within venv:
+(3) Install the farmbot-sidecar-starter-pack library within the virtual environment:
 ```bash
-python -m pip install requests paho-mqtt
+python -m pip install farmbot-sidecar-starter-pack
 ```
 
 ## :seedling: Getting Started
 
-Import `main` and create an instance of the Farmbot class:
+Import `farmbot_sidecar_starter_pack` and create an instance of the Farmbot class:
 ```python
-from main import Farmbot
+from farmbot_sidecar_starter_pack import Farmbot
 bot = Farmbot()
 ```
 
@@ -301,11 +291,48 @@ message = {
 
 ### Local development
 
-If you are working on the sidecar-starter-pack itself, ensure any changes pass all tests before submitting a pull request.
+If you are working on the sidecar-starter-pack itself,
+
+(1) Clone the repository.
+```bash
+git clone https://github.com/FarmBot-Labs/sidecar-starter-pack
+```
+
+(2) Navigate to the project directory.
+```bash
+cd sidecar-starter-pack
+```
+
+(3) Create a virtual environment.
+```bash
+python -m venv py_venv
+```
+
+(4) Activate the virtual environment.
+```bash
+source py_venv/bin/activate
+```
+
+(5) Install the required libraries within the virtual environment:
+```bash
+python -m pip install requests paho-mqtt coverage
+```
+
+Ensure any changes pass all tests before submitting a pull request.
 
 ```bash
-python -m pip install coverage
 coverage run -m unittest discover
+coverage html
 ```
 
-Additionally, you can check for test coverage by running `coverage html` and opening `htmlcov/index.html` in a browser.
+You can review test coverage by opening `htmlcov/index.html` in a browser.
+
+### Uploading package to PyPI (For FarmBot employees)
+
+Follow [this tutorial](https://packaging.python.org/en/latest/tutorials/packaging-projects/).
+```bash
+python -m pip install --upgrade pip build twine
+rm dist/*
+python -m build
+python -m twine upload dist/*
+```

__init__.py

@@ -2,14 +2,7 @@
 # Note: It will not copy any associated water, height, or spread curves ids
 # because they will not exist in the target account.
 
-# Add parent directory to Python path to allow `python examples/copy_plants_to_new_account.py`
-# `python -m examples.copy_plants_to_new_account` will work without this.
-import os
-import sys
-parent_dir = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
-sys.path.append(parent_dir)
-
-from main import Farmbot
+from farmbot_sidecar_starter_pack import Farmbot
 from time import sleep
 
 source = Farmbot()

examples/copy_plants_to_new_account.py

@@ -0,0 +1,7 @@
+"""
+Initialization for main module.
+"""
+
+from .main import Farmbot, VERSION
+
+__version__ = VERSION

farmbot_sidecar_starter_pack/__init__.py

@@ -2,21 +2,25 @@
 Farmbot class.
 """
 
-from state import State
-from functions.api import ApiConnect
-from functions.basic_commands import BasicCommands
-from functions.broker import BrokerConnect
-from functions.camera import Camera
-from functions.information import Information
-from functions.jobs import JobHandling
-from functions.messages import MessageHandling
-from functions.movements import MovementControls
-from functions.peripherals import Peripherals
-from functions.resources import Resources
-from functions.tools import ToolControls
+from .state import State
+from .functions.api import ApiConnect
+from .functions.basic_commands import BasicCommands
+from .functions.broker import BrokerConnect
+from .functions.camera import Camera
+from .functions.information import Information
+from .functions.jobs import JobHandling
+from .functions.messages import MessageHandling
+from .functions.movements import MovementControls
+from .functions.peripherals import Peripherals
+from .functions.resources import Resources
+from .functions.tools import ToolControls
+
+VERSION = "1.1.1"
 
 class Farmbot():
     """Farmbot class."""
+    __version__ = VERSION
+
     def __init__(self):
         self.state = State()
 

functions/__init__.py renamed to farmbot_sidecar_starter_pack/functions/__init__.py

@@ -0,0 +1,31 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "farmbot_sidecar_starter_pack"
+dynamic = ["version"]
+License = "MIT"
+authors = [
+    {name = "FarmBot Inc."},
+]
+keywords = ["farmbot", "sidecar"]
+description = "FarmBot Sidecar Starter Pack"
+readme = "README.md"
+requires-python = ">=3.8"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+]
+dependencies = [
+    "requests",
+    "paho-mqtt",
+]
+
+[project.urls]
+homepage = "https://github.com/FarmBot-Labs/sidecar-starter-pack"
+issues = "https://github.com/FarmBot-Labs/sidecar-starter-pack/issues"
+
+[tool.hatch.version]
+path = "farmbot_sidecar_starter_pack/main.py"

functions/api.py renamed to farmbot_sidecar_starter_pack/functions/api.py

@@ -7,7 +7,7 @@
 from unittest.mock import Mock, patch, call
 import requests
 
-from main import Farmbot
+from farmbot_sidecar_starter_pack import Farmbot
 
 MOCK_TOKEN = {
     'token': {