Merge pull request #42 from deppen8/docs-conda-forge

Move to 0.1.0

MANIFEST.in

@@ -0,0 +1,8 @@
+# Include the README
+include README.md
+
+# Include the license file
+include LICENSE
+
+# Include setup.py
+include setup.py

README.md

@@ -4,6 +4,8 @@
 
 [![PyPI](https://img.shields.io/pypi/v/prospect)](https://pypi.org/project/prospect/) ![PyPI - Downloads](https://img.shields.io/pypi/dm/prospect)
 
+[![Conda Version](https://img.shields.io/conda/vn/conda-forge/prospect.svg)](https://anaconda.org/conda-forge/prospect) [![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/prospect.svg)](https://anaconda.org/conda-forge/prospect)
+
 ![GitHub Workflow Status](https://img.shields.io/github/workflow/status/deppen8/prospect/Run%20tests?label=tests)
 [![codecov](https://codecov.io/gh/deppen8/prospect/branch/master/graph/badge.svg?token=05MJSIS9QA)](https://codecov.io/gh/deppen8/prospect) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
 

docs/prospect-guide/start/install.md

@@ -9,13 +9,31 @@ Installation
 You can see which packages `prospect` formally depends on by examining the [`setup.py` file](https://github.com/deppen8/prospect/blob/master/setup.py).
 ```
 
+### Installing with `conda`
+
+`prospect` is available from the `conda-forge` channel
+
+```bash
+$ conda install prospect -c conda-forge
+```
+
 ## Using `conda` environments
 
-`prospect` depends heavily on the `geopandas` package for handling spatial data. The GeoPandas team [recommends using the `conda` environment manager](https://geopandas.org/install.html) to help avoid some potential installation headaches, so the same goes for `prospect`: your best installation experience will be using `conda`. If you run into installation troubles, you might first revisit the [GeoPandas installation instructions](https://geopandas.org/install.html) to see if your issue is addressed there.
+`prospect` depends heavily on the `geopandas` package for handling spatial data. The GeoPandas team [recommends using the `conda` environment manager](https://geopandas.org/install.html) to help avoid some potential installation headaches, so the same goes for `prospect`: your best installation experience will be using `conda`.
+
+If you run into installation troubles, you might first revisit the [GeoPandas installation instructions](https://geopandas.org/install.html) to see if your issue is addressed there.
 
 ```{tip}
 If you are not familiar with using `conda`, I recommend these resources from the always-excellent EarthLab team:
 
 - [Use Conda Environments to Manage Python Dependencies: Everything That You Need to Know](https://www.earthdatascience.org/courses/intro-to-earth-data-science/python-code-fundamentals/use-python-packages/introduction-to-python-conda-environments/)
 - [Install Packages in Python](https://www.earthdatascience.org/courses/intro-to-earth-data-science/python-code-fundamentals/use-python-packages/use-conda-environments-and-install-packages/)
 ```
+
+### Installing with `pip`
+
+While it is not the recommended install strategy, `prospect` is available from PyPI.
+
+```bash
+$ python3 -m pip install prospect
+```

setup.cfg

@@ -0,0 +1,4 @@
+[metadata]
+# This includes the license file(s) in the wheel.
+# https://wheel.readthedocs.io/en/stable/user_guide.html#including-license-files-in-the-generated-wheel-file
+license_files = LICENSE

setup.py

@@ -1,12 +1,12 @@
-from setuptools import find_packages, setup
+from os import path
 
-# from os import path
+from setuptools import find_packages, setup
 
-# here = path.abspath(path.dirname(__file__))
+here = path.abspath(path.dirname(__file__))
 
 # # Get the long description from the README file
-# with open(path.join(here, 'README.md'), encoding='utf-8') as f:
-#     long_description = f.read()
+with open(path.join(here, "README.md"), encoding="utf-8") as f:
+    long_description = f.read()
 
 setup(
     # This is the name of your project. The first time you publish this
@@ -27,7 +27,7 @@
     # For a discussion on single-sourcing the version across setup.py and the
     # project code, see
     # https://packaging.python.org/en/latest/single_source_version.html
-    version="0.0.1",  # Required
+    version="0.1.0",  # Required
     # This is a one-line description or tagline of what your project does. This
     # corresponds to the "Summary" metadata field:
     # https://packaging.python.org/specifications/core-metadata/#summary
@@ -40,7 +40,7 @@
     #
     # This field corresponds to the "Description" metadata field:
     # https://packaging.python.org/specifications/core-metadata/#description-optional
-    # long_description=long_description,  # Optional
+    long_description=long_description,  # Optional
     # Denotes that our long_description is in Markdown; valid values are
     # text/plain, text/x-rst, and text/markdown
     #
@@ -51,7 +51,7 @@
     #
     # This field corresponds to the "Description-Content-Type" metadata field:
     # https://packaging.python.org/specifications/core-metadata/#description-content-type-optional
-    # long_description_content_type='text/markdown',  # Optional (see note above)
+    long_description_content_type="text/markdown",  # Optional (see note above)
     # This should be a valid link to your project's main homepage.
     #
     # This field corresponds to the "Home-Page" metadata field:
@@ -71,7 +71,7 @@
         #   3 - Alpha
         #   4 - Beta
         #   5 - Production/Stable
-        "Development Status :: 2 - Pre-Alpha",
+        "Development Status :: 4 - Beta",
         # Indicate who your project is intended for
         "Intended Audience :: Science/Research",
         "Topic :: Scientific/Engineering",
@@ -158,8 +158,8 @@
     # issues, where the source is hosted, where to say thanks to the package
     # maintainers, and where to support the project financially. The key is
     # what's used to render the link text on PyPI.
-    # project_urls={  # Optional
-    #     "Bug Reports": "",
-    #     "Research project home": "",
-    # },
+    project_urls={  # Optional
+        "Bug Reports": "https://github.com/deppen8/prospect",
+        "Documentation": "https://deppen8.github.io/prospect",
+    },
 )