diff --git a/README.md b/README.md index 9e93982..09c86ad 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,11 @@ The directory `original_code/` contains initial notebooks compiled from recent p The functionality of these notebooks is being ported to the `asp_plot/` directory, which is the package `asp_plot`. -## Installing and testing the package +## Installing, testing, and distributing the package + +### For Development + +If you instead want to install the source code for e.g. developing the project: ``` $ git clone git@github.com:uw-cryo/asp_plot.git @@ -33,6 +37,21 @@ To ensure the install was successful, tests can be run with: $ pytest ``` +### Package and upload + +``` +$ python3 -m pip install --upgrade build +$ python3 -m build +$ python3 -m pip install --upgrade twine +$ python3 -m twine upload dist/* +``` + +### Install via pip + +``` +pip install asp-plot +``` + ## Notebook example usage Examples of the modular usage of the package can be found in the `notebooks/` directory. diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..c894078 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,25 @@ +[build-system] +requires = ["setuptools>=61.0"] +build-backend = "setuptools.build_meta" + +[project] +name = "asp_plot" +version = "0.1.0" +authors = [ + { name="Ben Purinton", email="purinton@uw.edu" }, +] +description = "Package for plotting outputs Ames Stereo Pipeline processing" +readme = "README.md" +requires-python = ">=3.11" +classifiers = [ + "Programming Language :: Python :: 3", + "License :: OSI Approved :: BSD License", + "Operating System :: OS Independent", +] + +[project.scripts] +asp_plot = "asp_plot.cli.asp_plot:main" + +[project.urls] +Homepage = "https://github.com/uw-cryo/asp_plot" +Issues = "https://github.com/uw-cryo/asp_plot/issues"