jifunks · theobori · Aug 27, 2025
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,6 @@ garden_file.dat
 garden_file.json
 sqlite/
 *.swp
+build
+*.egg-info
+.venv
diff --git a/README.md b/README.md
@@ -11,11 +11,11 @@ Check in and water your plant every 24h to keep it growing. 5 days without water
 *"We do not 'come into' this world; we come out of it, as leaves from a tree." - Alan Watts*
 
 ## getting started
-botany is designed for unix-based systems. Clone into a local directory using `$ git clone https://github.com/jifunks/botany.git`.
+botany is designed for unix-based systems. Install it with pip using `$ python3 -m pip install git+https://github.com/jifunks/botany`.
 
-Run with `$ python3 botany.py`.
+By default, the game directory path is `/usr/share/botany`. Feel free to use [scripts/pre_build.sh](scripts/pre_build.sh) to modify it, it implies to clone this git repository.
 
-*Note - botany.py must initially be run by the user who cloned/unzipped botany.py - this initializes the shared data file permissions.*
+Run with `$ botany`.
 
 Water your seed to get started. You can come and go as you please and your plant continues to grow.
 

diff --git a/botany/__init__.py b/botany/__init__.py
diff --git a/art/agave1.txt → botany/art/agave1.txt b/art/agave1.txt → botany/art/agave1.txt
diff --git a/art/agave2.txt → botany/art/agave2.txt b/art/agave2.txt → botany/art/agave2.txt
diff --git a/art/agave3.txt → botany/art/agave3.txt b/art/agave3.txt → botany/art/agave3.txt
diff --git a/art/aloe1.txt → botany/art/aloe1.txt b/art/aloe1.txt → botany/art/aloe1.txt
diff --git a/art/aloe2.txt → botany/art/aloe2.txt b/art/aloe2.txt → botany/art/aloe2.txt
diff --git a/art/aloe3.txt → botany/art/aloe3.txt b/art/aloe3.txt → botany/art/aloe3.txt
diff --git a/art/baobab1.txt → botany/art/baobab1.txt b/art/baobab1.txt → botany/art/baobab1.txt
diff --git a/art/baobab2.txt → botany/art/baobab2.txt b/art/baobab2.txt → botany/art/baobab2.txt
diff --git a/art/baobab3.txt → botany/art/baobab3.txt b/art/baobab3.txt → botany/art/baobab3.txt
diff --git a/art/bee.txt → botany/art/bee.txt b/art/bee.txt → botany/art/bee.txt
diff --git a/art/brugmansia1.txt → botany/art/brugmansia1.txt b/art/brugmansia1.txt → botany/art/brugmansia1.txt
diff --git a/art/brugmansia2.txt → botany/art/brugmansia2.txt b/art/brugmansia2.txt → botany/art/brugmansia2.txt
diff --git a/art/brugmansia3.txt → botany/art/brugmansia3.txt b/art/brugmansia3.txt → botany/art/brugmansia3.txt
diff --git a/art/cactus1.txt → botany/art/cactus1.txt b/art/cactus1.txt → botany/art/cactus1.txt
diff --git a/art/cactus2.txt → botany/art/cactus2.txt b/art/cactus2.txt → botany/art/cactus2.txt
diff --git a/art/cactus3.txt → botany/art/cactus3.txt b/art/cactus3.txt → botany/art/cactus3.txt
diff --git a/art/columbine1.txt → botany/art/columbine1.txt b/art/columbine1.txt → botany/art/columbine1.txt
diff --git a/art/columbine2.txt → botany/art/columbine2.txt b/art/columbine2.txt → botany/art/columbine2.txt
diff --git a/art/columbine3.txt → botany/art/columbine3.txt b/art/columbine3.txt → botany/art/columbine3.txt
diff --git a/art/daffodil1.txt → botany/art/daffodil1.txt b/art/daffodil1.txt → botany/art/daffodil1.txt
diff --git a/art/daffodil2.txt → botany/art/daffodil2.txt b/art/daffodil2.txt → botany/art/daffodil2.txt
diff --git a/art/daffodil3.txt → botany/art/daffodil3.txt b/art/daffodil3.txt → botany/art/daffodil3.txt
diff --git a/art/fern1.txt → botany/art/fern1.txt b/art/fern1.txt → botany/art/fern1.txt
diff --git a/art/fern2.txt → botany/art/fern2.txt b/art/fern2.txt → botany/art/fern2.txt
diff --git a/art/fern3.txt → botany/art/fern3.txt b/art/fern3.txt → botany/art/fern3.txt
diff --git a/art/ficus1.txt → botany/art/ficus1.txt b/art/ficus1.txt → botany/art/ficus1.txt
diff --git a/art/ficus2.txt → botany/art/ficus2.txt b/art/ficus2.txt → botany/art/ficus2.txt
diff --git a/art/ficus3.txt → botany/art/ficus3.txt b/art/ficus3.txt → botany/art/ficus3.txt
diff --git a/art/flytrap1.txt → botany/art/flytrap1.txt b/art/flytrap1.txt → botany/art/flytrap1.txt
diff --git a/art/flytrap2.txt → botany/art/flytrap2.txt b/art/flytrap2.txt → botany/art/flytrap2.txt
diff --git a/art/flytrap3.txt → botany/art/flytrap3.txt b/art/flytrap3.txt → botany/art/flytrap3.txt
diff --git a/art/hemp1.txt → botany/art/hemp1.txt b/art/hemp1.txt → botany/art/hemp1.txt
diff --git a/art/hemp2.txt → botany/art/hemp2.txt b/art/hemp2.txt → botany/art/hemp2.txt
diff --git a/art/hemp3.txt → botany/art/hemp3.txt b/art/hemp3.txt → botany/art/hemp3.txt
diff --git a/art/iris1.txt → botany/art/iris1.txt b/art/iris1.txt → botany/art/iris1.txt
diff --git a/art/iris2.txt → botany/art/iris2.txt b/art/iris2.txt → botany/art/iris2.txt
diff --git a/art/iris3.txt → botany/art/iris3.txt b/art/iris3.txt → botany/art/iris3.txt
diff --git a/art/jackolantern.txt → botany/art/jackolantern.txt b/art/jackolantern.txt → botany/art/jackolantern.txt
diff --git a/art/jadeplant1.txt → botany/art/jadeplant1.txt b/art/jadeplant1.txt → botany/art/jadeplant1.txt
diff --git a/art/jadeplant2.txt → botany/art/jadeplant2.txt b/art/jadeplant2.txt → botany/art/jadeplant2.txt
diff --git a/art/jadeplant3.txt → botany/art/jadeplant3.txt b/art/jadeplant3.txt → botany/art/jadeplant3.txt
diff --git a/art/lithops1.txt → botany/art/lithops1.txt b/art/lithops1.txt → botany/art/lithops1.txt
diff --git a/art/lithops2.txt → botany/art/lithops2.txt b/art/lithops2.txt → botany/art/lithops2.txt
diff --git a/art/lithops3.txt → botany/art/lithops3.txt b/art/lithops3.txt → botany/art/lithops3.txt
diff --git a/art/moon.txt → botany/art/moon.txt b/art/moon.txt → botany/art/moon.txt
diff --git a/art/moss1.txt → botany/art/moss1.txt b/art/moss1.txt → botany/art/moss1.txt
diff --git a/art/moss2.txt → botany/art/moss2.txt b/art/moss2.txt → botany/art/moss2.txt
diff --git a/art/moss3.txt → botany/art/moss3.txt b/art/moss3.txt → botany/art/moss3.txt
diff --git a/art/pachypodium1.txt → botany/art/pachypodium1.txt b/art/pachypodium1.txt → botany/art/pachypodium1.txt
diff --git a/art/pachypodium2.txt → botany/art/pachypodium2.txt b/art/pachypodium2.txt → botany/art/pachypodium2.txt
diff --git a/art/pachypodium3.txt → botany/art/pachypodium3.txt b/art/pachypodium3.txt → botany/art/pachypodium3.txt
diff --git a/art/palm1.txt → botany/art/palm1.txt b/art/palm1.txt → botany/art/palm1.txt
diff --git a/art/palm2.txt → botany/art/palm2.txt b/art/palm2.txt → botany/art/palm2.txt
diff --git a/art/palm3.txt → botany/art/palm3.txt b/art/palm3.txt → botany/art/palm3.txt
diff --git a/art/pansy1.txt → botany/art/pansy1.txt b/art/pansy1.txt → botany/art/pansy1.txt
diff --git a/art/pansy2.txt → botany/art/pansy2.txt b/art/pansy2.txt → botany/art/pansy2.txt
diff --git a/art/pansy3.txt → botany/art/pansy3.txt b/art/pansy3.txt → botany/art/pansy3.txt
diff --git a/art/poppy1.txt → botany/art/poppy1.txt b/art/poppy1.txt → botany/art/poppy1.txt
diff --git a/art/poppy2.txt → botany/art/poppy2.txt b/art/poppy2.txt → botany/art/poppy2.txt
diff --git a/art/poppy3.txt → botany/art/poppy3.txt b/art/poppy3.txt → botany/art/poppy3.txt
diff --git a/art/rip.txt → botany/art/rip.txt b/art/rip.txt → botany/art/rip.txt
diff --git a/art/sage1.txt → botany/art/sage1.txt b/art/sage1.txt → botany/art/sage1.txt
diff --git a/art/sage2.txt → botany/art/sage2.txt b/art/sage2.txt → botany/art/sage2.txt
diff --git a/art/sage3.txt → botany/art/sage3.txt b/art/sage3.txt → botany/art/sage3.txt
diff --git a/art/seed.txt → botany/art/seed.txt b/art/seed.txt → botany/art/seed.txt
diff --git a/art/seedling.txt → botany/art/seedling.txt b/art/seedling.txt → botany/art/seedling.txt
diff --git a/art/snapdragon1.txt → botany/art/snapdragon1.txt b/art/snapdragon1.txt → botany/art/snapdragon1.txt
diff --git a/art/snapdragon2.txt → botany/art/snapdragon2.txt b/art/snapdragon2.txt → botany/art/snapdragon2.txt
diff --git a/art/snapdragon3.txt → botany/art/snapdragon3.txt b/art/snapdragon3.txt → botany/art/snapdragon3.txt
diff --git a/art/sun.txt → botany/art/sun.txt b/art/sun.txt → botany/art/sun.txt
diff --git a/art/sunflower1.txt → botany/art/sunflower1.txt b/art/sunflower1.txt → botany/art/sunflower1.txt
diff --git a/art/sunflower2.txt → botany/art/sunflower2.txt b/art/sunflower2.txt → botany/art/sunflower2.txt
diff --git a/art/sunflower3.txt → botany/art/sunflower3.txt b/art/sunflower3.txt → botany/art/sunflower3.txt
diff --git a/art/template.txt → botany/art/template.txt b/art/template.txt → botany/art/template.txt
diff --git a/botany/botany.py b/botany/botany.py
@@ -0,0 +1,61 @@
+
+from botany import menu_screen as ms
+from botany.plant import Plant
+from botany.data_manager import DataManager
+
+# TODO:
+# - switch from personal data file to row in DB
+# - is threading necessary?
+# - use a different curses window for plant, menu, info window, score
+
+# notes from vilmibm
+
+# there are threads.
+# - life thread. sleeps a variable amount of time based on generation bonus. increases tick count (ticks == score).
+# - screen: sleeps 1s per loop. draws interface (including plant). for seeing score/plant change without user input.
+# meanwhile, the main thread handles input and redraws curses as needed.
+
+# affordance index
+# - main screen
+#  navigable menu, plant, score, etc
+# - water
+#  render a visualization of moistness; allow to water
+# - look
+#  print a description of plant with info below rest of UI
+# - garden
+#  runs a paginated view of every plant on the computer below rest of UI. to return to menu navigation must hit q.
+# - visit
+#  runs a prompt underneath UI where you can see who recently visited you and type in a name to visit. must submit the prompt to get back to menu navigation.
+# - instructions
+#  prints some explanatory text below the UI
+# - exit
+#  quits program
+
+# part of the complexity of all this is everything takes place in one curses window; thus, updates must be manually synchronized across the various logical parts of the screen.
+# ideally, multiple windows would be used:
+# - the menu. it doesn't change unless the plant dies OR the plant hits stage 5, then "harvest" is dynamically added.
+# - the plant viewer. this is updated in "real time" as the plant grows.
+# - the status display: score and plant description
+# - the infow window. updated by visit/garden/instructions/look
+
+
+
+def main():
+    my_data = DataManager()
+    # if plant save file exists
+    if my_data.check_plant():
+        my_plant = my_data.load_plant()
+    # otherwise create new plant
+    else:
+        my_plant = Plant(my_data.savefile_path)
+        my_data.data_write_json(my_plant)
+    # my_plant is either a fresh plant or an existing plant at this point
+    my_plant.start_life(my_data)
+
+    ms.main(my_plant, my_data)
+    my_data.save_plant(my_plant)
+    my_data.data_write_json(my_plant)
+    my_data.update_garden_db(my_plant)
+
+if __name__ == '__main__':
+    main()    
diff --git a/botany-view.py → botany/botany_view.py b/botany-view.py → botany/botany_view.py
@@ -1,8 +1,8 @@
-#!/usr/bin/env python3
-
+import os
 import datetime
 
-from botany import *
+from botany.plant import Plant
+from botany.data_manager import DataManager
 
 def ascii_render(filename):
     # Prints ASCII art from file at given coordinates
@@ -58,7 +58,7 @@ def draw_plant_ascii(this_plant):
         this_filename = plant_art_list[this_plant.species]+'3.txt'
         ascii_render(this_filename)
 
-if __name__ == '__main__':
+def main():
     my_data = DataManager()
     # if plant save file exists
     if my_data.check_plant():
@@ -68,3 +68,6 @@ def draw_plant_ascii(this_plant):
         my_plant = Plant(my_data.savefile_path)
         my_data.data_write_json(my_plant)
     draw_plant_ascii(my_plant)
+
+if __name__ == '__main__':
+    main()    
diff --git a/completer.py → botany/completer.py b/completer.py → botany/completer.py
diff --git a/botany.py → botany/data_manager.py b/botany.py → botany/data_manager.py
@@ -1,52 +1,14 @@
-#!/usr/bin/env python3
-
 import time
 import pickle
 import json
 import os
 import getpass
-import threading
 import errno
 import sqlite3
-import menu_screen as ms
-from plant import Plant
-
-# TODO:
-# - switch from personal data file to row in DB
-# - is threading necessary?
-# - use a different curses window for plant, menu, info window, score
-
-# notes from vilmibm
-
-# there are threads.
-# - life thread. sleeps a variable amount of time based on generation bonus. increases tick count (ticks == score).
-# - screen: sleeps 1s per loop. draws interface (including plant). for seeing score/plant change without user input.
-# meanwhile, the main thread handles input and redraws curses as needed.
-
-# affordance index
-# - main screen
-#  navigable menu, plant, score, etc
-# - water
-#  render a visualization of moistness; allow to water
-# - look
-#  print a description of plant with info below rest of UI
-# - garden
-#  runs a paginated view of every plant on the computer below rest of UI. to return to menu navigation must hit q.
-# - visit
-#  runs a prompt underneath UI where you can see who recently visited you and type in a name to visit. must submit the prompt to get back to menu navigation.
-# - instructions
-#  prints some explanatory text below the UI
-# - exit
-#  quits program
 
-# part of the complexity of all this is everything takes place in one curses window; thus, updates must be manually synchronized across the various logical parts of the screen.
-# ideally, multiple windows would be used:
-# - the menu. it doesn't change unless the plant dies OR the plant hits stage 5, then "harvest" is dynamically added.
-# - the plant viewer. this is updated in "real time" as the plant grows.
-# - the status display: score and plant description
-# - the infow window. updated by visit/garden/instructions/look
+GAME_DIR = "/usr/share/botany"
 
-class DataManager(object):
+class DataManager:
     # handles user data, puts a .botany dir in user's home dir (OSX/Linux)
     # handles shared data with sqlite db
     # TODO: .dat save should only happen on mutation, water, death, exit,
@@ -56,7 +18,9 @@ class DataManager(object):
 
     user_dir = os.path.expanduser("~")
     botany_dir = os.path.join(user_dir,'.botany')
-    game_dir = os.path.dirname(os.path.realpath(__file__))
+
+    game_dir = os.getenv("BOTANY_GAME_DIR") or GAME_DIR
+
     this_user = getpass.getuser()
 
     savefile_name = this_user + '_plant.dat'
@@ -283,21 +247,4 @@ def harvest_plant(self, this_plant):
         with open(self.harvest_json_path, 'w') as outfile:
             json.dump(this_harvest, outfile)
 
-        return new_file_check
-
-if __name__ == '__main__':
-    my_data = DataManager()
-    # if plant save file exists
-    if my_data.check_plant():
-        my_plant = my_data.load_plant()
-    # otherwise create new plant
-    else:
-        my_plant = Plant(my_data.savefile_path)
-        my_data.data_write_json(my_plant)
-    # my_plant is either a fresh plant or an existing plant at this point
-    my_plant.start_life(my_data)
-
-    ms.main(my_plant, my_data)
-    my_data.save_plant(my_plant)
-    my_data.data_write_json(my_plant)
-    my_data.update_garden_db(my_plant)
+        return new_file_check
diff --git a/menu_screen.py → botany/menu_screen.py b/menu_screen.py → botany/menu_screen.py
@@ -10,13 +10,11 @@
 import string
 import threading
 import time
-from typing import TYPE_CHECKING
 
-import completer
-from plant import Plant
 
-if TYPE_CHECKING:
-    from botany import DataManager
+from botany import completer
+from botany.plant import Plant
+from botany.data_manager import DataManager
 
 
 class CursedMenu(object):
@@ -638,9 +636,7 @@ def build_latest_visitor_output(self, visitors):
         return [visitor_line]
 
     def get_weekly_visitors(self):
-        game_dir = os.path.dirname(os.path.realpath(__file__))
-        garden_db_path = os.path.join(game_dir, 'sqlite/garden_db.sqlite')
-        conn = sqlite3.connect(garden_db_path)
+        conn = sqlite3.connect(DataManager.garden_db_path)
         c = conn.cursor()
         c.execute("SELECT * FROM visitors WHERE garden_name = '{}' ORDER BY weekly_visits".format(self.plant.owner))
         visitor_data = c.fetchall()

diff --git a/plant.py → botany/plant.py b/plant.py → botany/plant.py
@@ -5,6 +5,9 @@
 import time
 import uuid
 import getpass
+import sqlite3
+
+from botany.data_manager import DataManager
 
 class Plant:
     # This is your plant!
@@ -198,8 +201,7 @@ def dead_check(self):
         return self.dead
 
     def update_visitor_db(self, visitor_names):
-        game_dir = os.path.dirname(os.path.realpath(__file__))
-        garden_db_path = os.path.join(game_dir, 'sqlite/garden_db.sqlite')
+        garden_db_path = os.path.join(DataManager.garden_db_path)
         conn = sqlite3.connect(garden_db_path)
         for name in (visitor_names):
             c = conn.cursor()

diff --git a/pyproject.toml b/pyproject.toml
@@ -0,0 +1,56 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "botany"
+version = "0.0.1"
+requires-python = ">=3"
+authors = [
+  {name = "Jake Funke", email = "jifunks@gmail.com"}
+]
+maintainers = [
+  {name = "Jake Funke", email = "jifunks@gmail.com"}
+]
+description = "A command line, realtime, community plant buddy."
+readme = "README.md"
+license = "ISC"
+license-files = ["LICENSE"]
+keywords = [
+  "plant",
+  "virtual",
+  "garden",
+  "cli",
+  "curses",
+  "pet",
+  "tilde",
+]
+classifiers = [
+  "Programming Language :: Python",
+  "Environment :: Console",
+  "Environment :: Console :: Curses",
+  "Topic :: Games/Entertainment",
+  "Topic :: Games/Entertainment :: Simulation",
+  "Topic :: Multimedia :: Graphics",
+  "Topic :: System :: Shells",
+  "Topic :: Terminals",
+  "Operating System :: POSIX",
+  "Operating System :: Unix",
+]
+
+[project.scripts]
+botany = "botany.botany:main"
+botany-view = "botany.botany_view:main"
+
+[project.urls]
+Homepage = "https://github.com/jifunks/botany"
+Documentation = "https://github.com/jifunks/botany"
+Repository = "https://github.com/jifunks/botany"
+"Bug Tracker" = "https://github.com/jifunks/botany/issues"
+
+[tool.setuptools]
+packages = ["botany"]
+include-package-data = true
+
+[tool.setuptools.package-data]
+botany = ["art/*.txt"]
diff --git a/clear_weekly_users.py → scripts/clear_weekly_users.py b/clear_weekly_users.py → scripts/clear_weekly_users.py
@@ -1,8 +1,15 @@
+#!/usr/bin/env python3
+
 import os
 import sqlite3
 
-game_dir = os.path.dirname(os.path.realpath(__file__))
-garden_db_path = os.path.join(game_dir, 'sqlite/garden_db.sqlite')
+from sys import argv
+
+argc = len(argv)
+
+game_dir = "/usr/share/botany"
+garden_db_path = os.path.join(game_dir, 'sqlite/garden_db.sqlite') if argc <= 1 else argv[1]
+
 conn = sqlite3.connect(garden_db_path)
 c = conn.cursor()
 c.execute("DELETE FROM visitors")

diff --git a/scripts/pre_build.sh b/scripts/pre_build.sh
@@ -0,0 +1,30 @@
+#!/usr/bin/env bash
+
+set -e
+
+readonly GAME_DIR=${1}
+readonly CURRENT_DIR=$(dirname ${0})
+readonly PROJECT_ROOT_DIR=${PROJECT_ROOT_DIR:-"${CURRENT_DIR}/.."}
+
+if [ "$#" -ne 1 ]
+then
+  echo "Usage example: ${0} \"/srv/botany\""
+  exit 1
+fi
+
+if ! command -v sed &> /dev/null
+then
+  echo "The script needs the 'sed' program." >&2
+  exit 1
+fi
+
+
+mkdir -p "${GAME_DIR}"
+chmod 755 "${GAME_DIR}"
+echo "The directory '${GAME_DIR}' has been initialized."
+
+sed -i -e \
+  "s|GAME_DIR = \".*\"|GAME_DIR = \"${GAME_DIR}\"|g"\
+  "${PROJECT_ROOT_DIR}/botany/data_manager.py"
+
+echo "The game directory value has been successfully substitued with '${GAME_DIR}'."
diff --git a/testsql.py → scripts/testsql.py b/testsql.py → scripts/testsql.py
@@ -1,6 +1,14 @@
+#!/usr/bin/env python3
+
+import os
 import sqlite3
 
-garden_db_path = "sqlite/garden_db.sqlite"
+from sys import argv
+
+argc = len(argv)
+
+game_dir = "/usr/share/botany"
+garden_db_path = os.path.join(game_dir, 'sqlite/garden_db.sqlite') if argc <= 1 else argv[1]
 
 def init_database():
     #TODO: does this need permissions?
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,3 +4,6 @@ garden_file.dat @@
     garden_file.json
     sqlite/
     *.swp
+    build
+    *.egg-info
+    .venv