Docs and fix

.github/workflows/deploy_mkdocs.yml

@@ -0,0 +1,35 @@
+name: Publish docs via GitHub Pages
+
+on:
+  push:
+    branches:
+      - master
+    paths:
+      # Only rebuild website when docs have changed
+      - 'README.md'
+      - 'CHANGES.md'
+      - 'CONTRIBUTING.md'
+      - 'mkdocs.yml'
+      - 'docs/**'
+
+jobs:
+  build:
+    name: Deploy docs
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout master
+        uses: actions/checkout@v2
+
+      - name: Set up Python 3.8
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.8
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install numpy
+          python -m pip install -e .["docs"]
+
+      - name: Deploy docs
+        run: mkdocs gh-deploy --force

CHANGES.md

@@ -0,0 +1,198 @@
+# Release Notes
+
+## 2.0a7.post1 (2020-09-23)
+
+* Fix wrong min-zoom calculation in `rio_cogeo.cogeo.cog_info`
+
+## 2.0a7 (2020-09-23)
+* remove duplicate `count` information in rio_cogeo.cogeo.cog_info output (#150)
+* allow COG with IFD offset up to 200 bytes to accomodate with GDAL 3.1 changes (#151)
+* fix zoom level calculation in `rio_cogeo.cogeo.cog_info`
+
+## 2.0a6 (2020-08-18)
+
+* fix bug in cogeo.info when CRS in not set.
+* add minzoom/maxzoom in cogeo.info output.
+
+**Breaking Changes:**
+* rio_cogeo.utils.get_max_zoom renamed rio_cogeo.utils.get_zooms and now return min/max zoom.
+
+## 2.0a5 (2020-07-31)
+
+* move most of the cogeo info code in rio_cogeo.cogeo.cog_info api
+* add cog_validation info in cogeo info result
+* cog_validate returns a tuple (is_valid, errors, warnings) (#142, co-author with @geospatial-jeff)
+* add scale, offset, image tags and band color interpretation in cog_info (#145, #146 and #147)
+
+## 2.0a4 (2020-06-15)
+
+* Force output width and height (#140)
+
+## 2.0a3 (2020-06-15)
+
+* add `info` CLI (#134)
+* use `Deflate` as default temporary compression (#137)
+
+## 2.0a2 (2020-05-20)
+
+* add `--config` CLI option to pass additional GDAL Configuration options (#135)
+
+## 2.0a1 (2020-05-07)
+
+* **Dropping python 2** (#128)
+* use new mercantile xy_bounds for better web-optimized file (#126)
+* Allow temporary file on disk when using MemoryFile output
+* add `--blocksize` option in CLI (#131)
+* depreciate `rio_cogeo.utils.get_maximum_overview_level` and use rasterio.rio.overview.get_maximum_overview_level (#132)
+
+## 1.1.10 (2020-02-21)
+
+* Transfer colormap (#121)
+
+## 1.1.9 (2020-02-06)
+
+* Transfer scale and offset values to output COG (#118)
+
+## 1.1.8 (2020-01-08)
+
+* Transfer color interpretation value to output COG (#113) * Thanks @pierotofy
+* Cast `dataset_mask` returned by rasterio to uint8 to overcome a bug in rasterio 1.1.2 (#115)
+
+## 1.1.7 (2019-12-02)
+
+* add `strict` option to cog_validate to treat warnings as error (#109) * Thanks @pierotofy
+* add documentation examples using MemoryFiles (#108 #107)
+* Switch to `PHOTOMETRIC=MINISBLACK` when PHOTOMETRIC is set to YCBCR for 1 band dataset (#41)
+
+## 1.1.6 (2019-11-13)
+
+* add `-forward-band-tags` options (#115)
+
+## 1.1.5 (2019-10-04)
+
+* add `--allow-intermediate-compression` option to reduce the memory/disk footprint (#103)
+
+## 1.1.4 (2019-10-03)
+
+* Fix support for optimizing open datasets, memfiles, and VRTs (#100 from j08lue)
+
+## 1.1.3 (2019-09-16)
+
+* Add lzma/lerc/lerc_deflate/lerc_zstd profiles (#97)
+* Add warnings and notes for `non-standard` compression (#97)
+* fix THREADS definition for GDAL config
+
+## 1.1.2 (2019-09-12)
+
+* Fix incorrect context behavior closing input Dataset (#94)
+
+## 1.1.1 (2019-09-10)
+
+* add safeguard to keep datatype from input to output files (#85)
+
+**CLI Changes:**
+* add `-t, --dtype` datatype option.
+
+**API Changes:**
+* add datatype option
+* update for rasterio>=1.0.28
+* allow rasterio.io.DatasetReader input (#89)
+
+Note: This release was deleted in PyPi.
+
+## 1.1.0 (2019-07-16)
+
+* check internal blocksize and adapt if raster is too small (#80)
+
+## 1.0.0 (2019-04-19)
+
+* add `--web-optimized` option to create a web optimized COG (#10)
+* add `--latitude-adjustment/--global-maxzoom` option to adjust MAX_ZOOM for global datasets
+* Web-optimized tests needs python3.6 (cogdumper)
+* add `--resampling` option to select the resampling algorithm when using `--web-optimized`
+* add `--in-memory/--no-in-memory` options to use temporyNamedd file instead of in-memory temp file.
+
+## 1.0b3 (2019-03-30)
+
+**Breaking Changes:**
+
+* remove deprecated YCBCR profile
+* 512x512 dataset without internal tiling are valid
+
+## 1.0b2 (2019-03-27)
+
+**Breaking Changes:**
+
+* Switch from JPEG to DEFLATE as default profile in CLI (#66)
+
+## 1.0b1 (2019-03-25)
+
+**Breaking Changes:**
+
+* refactor utils.get_maximum_overview_level to get rasterio dataset
+as input and reduce the number of dataset opennings (#61)
+
+## 1.0b0 (2019-03-15)
+
+* add more logging and `--quiet` option (#46)
+* add `--overview-blocksize` to set overview's internal tile size (#60)
+
+**Bug fixes:**
+
+* copy tags and description from input to output (#19)
+* copy input mask band to output mask
+
+**Breaking Changes:**
+
+* rio cogeo now has subcommands: 'create' and 'validate' (#6).
+* internal mask creation is now optional (--add-mask).
+* internal nodata or alpha channel can be forwarded to the output dataset.
+* removed default overview blocksize to be equal to the raw data blocksize (#60)
+
+## 1.0dev10 (2019-02-12)
+
+* allow non integer nodata value (#51)
+* fix GDAL blocksize options casting for overview calculation (#50)
+
+## 1.0dev9 (2019-02-11)
+
+* Renamed "ycbcr" profile's name to "jpeg" to reflect the compression name.
+  "ycbcr" profile will raise a "DeprecationWarning" (#44)
+* "webp" profile has been added to COG profiles. Exploitation of this new
+  compression mode will require GDAL 2.4 (#27)
+* Rio-cogeo can calculate the overview level based on the internal tile size
+  and the dataset width/height (#37)
+
+## 1.0dev8 (2018-10-02)
+
+* write tags in output file (#31)
+* add bilinear, cubic spline, lanczos resampling modes for overviews
+
+## 1.0dev7 (2018-09-12)
+
+* add resampling option for overviews (#28)
+
+## 1.0dev6 (2018-08-23)
+
+* Remove unnecessary compression for in-memory step (reduce runtime and memory usage) (#25)
+
+## 1.0dev4 (2018-07-16)
+
+* rasterio 1.0
+
+## 1.0dev3 (2018-07-05)
+
+* remove default bidx in cli (#17)
+
+## 1.0dev2 (2018-06-28)
+
+* Add ZSTD compressed COG profile (#14)
+* Fix warnings for useless boundless=True option (#13)
+* add BIGTIFF=IF_SAFER to COG profile (if BIGTIFF not set otherwise in the env)
+
+**Breaking Changes:**
+* replace "BAND" by "PIXEL" interleave in PACKBITS profile (#16)
+
+## 1.0dev1(2018-16-13)
+
+* Initial release. Requires Rasterio >= 1.0b1.