From 9ab7983b61dfa958fb8a49d2868ec5c51a67c73a Mon Sep 17 00:00:00 2001 From: Jacob Deppen Date: Tue, 2 Feb 2021 01:33:17 -0500 Subject: [PATCH 1/4] update installation instructions --- docs/prospect-guide/start/install.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/docs/prospect-guide/start/install.md b/docs/prospect-guide/start/install.md index 21fb382..5bcae01 100644 --- a/docs/prospect-guide/start/install.md +++ b/docs/prospect-guide/start/install.md @@ -9,9 +9,19 @@ 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: @@ -19,3 +29,11 @@ If you are not familiar with using `conda`, I recommend these resources from the - [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 +``` From 07ca14059ad9265ef015e749d6d2aa5c1c94db53 Mon Sep 17 00:00:00 2001 From: Jacob Deppen Date: Tue, 2 Feb 2021 01:34:42 -0500 Subject: [PATCH 2/4] add files needed to include license in build --- MANIFEST.in | 8 ++++++++ setup.cfg | 4 ++++ 2 files changed, 12 insertions(+) create mode 100644 MANIFEST.in create mode 100644 setup.cfg diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..4d76505 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,8 @@ +# Include the README +include README.md + +# Include the license file +include LICENSE + +# Include setup.py +include setup.py diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..5838cae --- /dev/null +++ b/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 From 6c0f8c176a5748fe622a76d79ad36638887342f8 Mon Sep 17 00:00:00 2001 From: Jacob Deppen Date: Tue, 2 Feb 2021 01:37:32 -0500 Subject: [PATCH 3/4] bump version to 0.1.0 --- setup.py | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/setup.py b/setup.py index 69a3a10..6d26303 100644 --- a/setup.py +++ b/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", + }, ) From 6ab4dd76659bc2ebccd19cd9b4231dccd8b43ee5 Mon Sep 17 00:00:00 2001 From: Jacob Deppen Date: Tue, 2 Feb 2021 23:00:49 -0500 Subject: [PATCH 4/4] Add conda-forge badges to README --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 4ea4b2c..6a4b287 100644 --- a/README.md +++ b/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)