Merge pull request #64 from aazuspan/pyproject

pyproject.toml, Hatch, and MIT license

.gitignore

@@ -1,5 +1,6 @@
 __pycache__/
 .mypy_cache/
+.pytest_cache/
 *.pyc
 .ipynb_checkpoints/
 .vscode/

docs/conf.py

@@ -13,6 +13,8 @@
 import os
 import sys
 
+from wxee import __version__
+
 sys.path.insert(0, os.path.abspath(".."))
 
 
@@ -21,7 +23,7 @@
 project = "wxee"
 copyright = "2021, Aaron Zuspan"
 author = "Aaron Zuspan"
-version = "0.3.3"
+version = __version__
 
 # -- General configuration ---------------------------------------------------
 

docs/contributing.rst

@@ -12,7 +12,8 @@ Setup
 
  git clone https://github.com/{username}/wxee
  cd wxee
- make install-dev
+ pip install -e .[dev]
+ pre-commit install
 
 #. Create a new feature branch.
 
@@ -31,8 +32,8 @@ Setup
 
  .. code-block:: bash
 
- make docs
- make view-docs
+ hatch run docs:build
+ hatch run docs:view
 
 
 Tests
@@ -58,4 +59,4 @@ For example:
 Running Tests
 ^^^^^^^^^^^^^
 
-To run all tests, use :code:`make tests`. If you cannot connect to Earth Engine or would like to skip slower tests, use :code:`make tests-local`.
+To run all tests, use :code:`hatch run test:all`. If you cannot connect to Earth Engine or would like to skip slower tests, use :code:`hatch run test:local`.

pyproject.toml

@@ -0,0 +1,115 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "wxee"
+dynamic = ["version"]
+description = "Earth Engine to xarray interface"
+readme = "README.rst"
+license = "MIT"
+requires-python = ">=3.8"
+authors = [
+ { name = "Aaron Zuspan", email = "[email protected]" },
+]
+keywords = [
+ "earth-engine",
+ "xarray",
+ "time-series",
+]
+classifiers = [
+ "Development Status :: 4 - Beta",
+ "Intended Audience :: Science/Research",
+ "Natural Language :: English",
+ "Programming Language :: Python :: 3",
+ "Programming Language :: Python :: 3.8",
+ "Programming Language :: Python :: 3.9",
+ "Programming Language :: Python :: 3.10",
+ "Topic :: Scientific/Engineering :: GIS",
+ "Typing :: Typed",
+]
+dependencies = [
+ "earthengine-api",
+ "joblib",
+ "netcdf4",
+ "plotly>=5.2.2",
+ "rasterio",
+ "requests",
+ "rioxarray",
+ "tqdm",
+ "xarray",
+]
+
+[project.optional-dependencies]
+dev = [
+ "black",
+ "hatch",
+ "hvplot",
+ "isort",
+ "matplotlib",
+ "mock",
+ "mypy",
+ "nbsphinx",
+ "pre-commit",
+ "pytest",
+ "pytest-cov",
+ "requests_mock",
+ "sphinx",
+ "sphinx_rtd_theme",
+]
+doc = [
+ "nbsphinx",
+ "sphinx",
+ "sphinx_rtd_theme",
+]
+test = [
+ "hvplot",
+ "matplotlib",
+ "mock",
+ "pytest",
+ "pytest-cov",
+ "requests_mock",
+]
+
+[project.urls]
+Homepage = "https://github.com/aazuspan/wxee"
+
+[tool.hatch.version]
+path = "wxee/__init__.py"
+
+
+[tool.hatch.build.targets.sdist]
+include = [
+ "/wxee",
+]
+
+[tool.hatch.envs.docs]
+dependences = [
+ "nbsphinx",
+ "sphinx",
+ "sphinx_rtd_theme",
+]
+
+[tool.hatch.envs.docs.scripts]
+build = "sphinx-build -b html docs docs/_build/html"
+view = "python -m webbrowser -t docs/_build/html/index.html"
+
+
+[tool.hatch.envs.test]
+dependencies = [
+ "hvplot",
+ "matplotlib",
+ "mock",
+ "pytest",
+ "pytest-cov",
+ "requests_mock",
+]
+
+[tool.hatch.envs.test.scripts]
+all = "pytest ."
+local = "pytest . -m 'not ee'"
+coverage = "pytest . --cov=wxee --cov-report=html"
+view-coverage = "python -m webbrowser -t htmlcov/index.html"
+
+[tool.pytest.ini_options]
+markers = "ee: Marks tests that require an Earth Engine connection. These can be skipped using `pytest -m 'not ee' .`"