diff --git a/README.md b/README.md index 44c14b6..d6cfcbf 100644 --- a/README.md +++ b/README.md @@ -1 +1,32 @@ -# Loon Utilities Package - Help convert your microscopy data into a format that Loon uses for data visualization. \ No newline at end of file +# Loon Utilities Package + +A suite of tools to help **convert** your **cell microscopy** data for **visualization** in [Loon.](https://vdl.sci.utah.edu/loonar/) + +[Loon](https://vdl.sci.utah.edu/loonar/) is a **data visualization software** for cell microscopy data. + +Loon expects data in a specified [format](https://vdl.sci.utah.edu/loonar/docs/getting-started-with-loon/data) in order to be visualized. + + +## Quick Start + +### 1. Install via command line +```sh +pip install loon-utils +``` + +### 2. Test + +- #### In a Python session + ```py + from loon_utils import hello + hello() + ``` + +- #### Or, run from the command line + ```sh + hello + ``` + +## Contributing + +To help develop or add conversion tools, open an issue or submit a descriptive pull request. \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index ca470f3..b664c2d 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [project] name = "loon-utils" -version = "0.0.3" +version = "0.0.4" description = "A python library for updating / converting data for use in Loon visualization" readme = "README.md" authors = [ @@ -28,9 +28,12 @@ dev = [ "pytest>=8.3.5", ] -[tool.hatch.build.targets.wheel] -packages = ["src/loon_utils"] +[tool.hatch.build.packages.find] +where = "src" +include = ["loon_utils"] +[project.scripts] +hello = "loon_utils.main:hello" [project.urls] Homepage = "https://github.com/visdesignlab/loon-utils" \ No newline at end of file diff --git a/setup.py b/setup.py index 1285dde..8dc1469 100644 --- a/setup.py +++ b/setup.py @@ -1,8 +1,14 @@ from setuptools import setup, find_packages +import tomllib +from pathlib import Path + +pyproject_path = Path(__file__).with_name("pyproject.toml") +pyproject = tomllib.loads(pyproject_path.read_text()) +version = pyproject["project"]["version"] setup( name='loon-utils', - version='0.1.1', + version=version, packages=find_packages(), install_requires=[ # Add your dependencies here