final changes for v1.0.0

CHANGELOG.md

@@ -1,4 +1,4 @@
-# Python-seabreeze changelog
+# seabreeze changelog
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
@@ -13,8 +13,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 
 ## [Unreleased]
+
+## [1.0.0]
+### Added
+- *docs* install via [piwheels](https://www.piwheels.hostedpi.com/project/seabreeze/)
+
+### Changed
+- *docs* install via conda
+- *docs* minor layout fixes and python-seabreeze vs seabreeze renaming
+
 ### Fixed
 - `seabreeze_os_setup` fix py3 error when udev rules differed on linux
+- fix links in changelog
 
 ## [1.0.0rc4] - 2017-09-07
 ### Added
@@ -67,9 +77,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Don't require numpy during build of cseabreeze cython extension
 
-[Unreleased]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0rc4...HEAD
-[1.0.0rc4]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0rc3...v1.0.0rc4
-[1.0.0rc3]: https://github.com/olivierlacan/keep-a-changelog/compare/v1.0.0rc2...v1.0.0rc3
-[1.0.0rc2]: https://github.com/olivierlacan/keep-a-changelog/compare/python-seabreeze-v0.6.0...v1.0.0rc2
-[0.6.0]: https://github.com/olivierlacan/keep-a-changelog/compare/python-seabreeze-v0.5.3...python-seabreeze-v0.6.0
+[Unreleased]: https://github.com/ap--/python-seabreeze/compare/v1.0.0...HEAD
+[1.0.0]: https://github.com/ap--/python-seabreeze/compare/v1.0.0rc4...v1.0.0
+[1.0.0rc4]: https://github.com/ap--/python-seabreeze/compare/v1.0.0rc3...v1.0.0rc4
+[1.0.0rc3]: https://github.com/ap--/python-seabreeze/compare/v1.0.0rc2...v1.0.0rc3
+[1.0.0rc2]: https://github.com/ap--/python-seabreeze/compare/python-seabreeze-v0.6.0...v1.0.0rc2
+[0.6.0]: https://github.com/ap--/python-seabreeze/compare/python-seabreeze-v0.5.3...python-seabreeze-v0.6.0
 [0.5.3]: https://github.com/ap--/python-seabreeze/tree/python-seabreeze-v0.5.3

docs/source/contributing.rst

@@ -3,7 +3,8 @@ Contributing Guide
 
 .. _contrib:
 
-If you want to contribute to python-seabreeze, please create a pull request on github.
+If you want to contribute to seabreeze, please create a pull request on github.
+Documentation improvements are very welcome!
 Extending pyseabreeze is quite easy. Look at the examples below.
 
 .. tip::
@@ -14,8 +15,9 @@ Extending pyseabreeze is quite easy. Look at the examples below.
 Adding a new spectrometer
 -------------------------
 
-To add a new spectrometer with basic spectrometer functionality to `pyseabreeze` you need to
-do two things:
+To add a new spectrometer with basic spectrometer functionality to `pyseabreeze` you
+first need to find a datasheet pdf of your spectrometer to get the necessary information
+and then you need to do two things:
 
 Add a new device class to `seabreeze/pyseabreeze/devices.py`:
 
@@ -88,7 +90,7 @@ results in a github issue. To do this git clone the repository and:
     skipping 'src/seabreeze/cseabreeze/c_seabreeze_wrapper.cpp' Cython extension (up-to-date)
     copying build/lib.linux-x86_64-2.7/seabreeze/cseabreeze/_wrapper.so -> src/seabreeze/cseabreeze
     ========================================== test session starts ==========================================
-    platform linux2 -- Python 2.7.15+, pytest-4.6.5, py-1.8.0, pluggy-0.12.0 -- /home/poehlmann/Development/python-seabreeze/venv/bin/python
+    platform linux2 -- Python 2.7.15+, pytest-4.6.5, py-1.8.0, pluggy-0.12.0 -- /python
     cachedir: .pytest_cache
     rootdir: /home/poehlmann/Development/python-seabreeze, inifile: pytest.ini
     collected 23 items
@@ -197,4 +199,5 @@ results in a github issue. To do this git clone the repository and:
 
     -- Docs: https://docs.pytest.org/en/latest/warnings.html
     =========================== 1 failed, 22 passed, 2 warnings in 34.78 seconds ============================
-    Exception AttributeError: "'NoneType' object has no attribute '_ctx'" in <bound method SPARK.__del__ of <SeaBreezeDevice SPARK:00061>> ignored
+    Exception AttributeError: "'NoneType' object has no attribute '_ctx'" in
+        <bound method SPARK.__del__ of <SeaBreezeDevice SPARK:00061>> ignored

docs/source/install.rst

@@ -1,35 +1,39 @@
-Installing python-seabreeze
-===========================
+Installing seabreeze
+====================
 
 .. _install-seabreeze:
 
-Install via pip
----------------
-
-.. danger::
-
-    Until version v1.0.0 is fully released pip install requires the `--pre` argument to install
-    the pypi prerelease.
+Installing via pip
+------------------
 
 .. code:: bash
 
     # install only cseabreeze backend
-    pip install seabreeze --pre
+    pip install seabreeze
     # install both cseabreeze and pyseabreeze backend
-    pip install seabreeze[pyseabreeze] --pre
+    pip install seabreeze[pyseabreeze]
     # install only pyseabreeze backend
-    pip install seabreeze[pyseabreeze] --no-build-isolation --install-option="--without-cseabreeze" --pre
+    pip install seabreeze[pyseabreeze] --no-build-isolation --install-option="--without-cseabreeze"
 
 
-Install via conda
------------------
+Installing via conda
+--------------------
+
+.. code:: bash
 
-.. Attention::
-    Not working yet. Need to add `conda-forge` or continue to build own packages (maybe via travis too?)
+    # install via conda
+    conda install -c poehlmann seabreeze
 
+.. note::
+    For now the packages are provided via the `poehlmann` conda channel. It's on the roadmap to
+    move to `conda-forge`.
 
-Building python-seabreeze manually
-----------------------------------
+.. attention::
+    Before version 1 conda packages for seabreeze were named *python-seabreeze*. This has now
+    changed to be consistent with the pypi package naming.
+
+Building seabreeze manually
+---------------------------
 
 If you want to build python-seabreeze manually you have to install some build dependencies.
 
@@ -41,11 +45,14 @@ Linux requires a compiler and libusb development headers:
 .. code:: bash
 
     # run the appropriate command for your distribution flavor
-    # - if your distro is a deb flavor (ubuntu, etc...)
+
+    # if your distro is a deb flavor (ubuntu, etc...)
     sudo apt-get install git-all build-essential libusb-dev
-    # - if your distro is a rpm flavor
+
+    # if your distro is a rpm flavor
     sudo yum install git-all gcc gcc-c++ make libusb-devel
-    # - if your distro is a arch flavor
+
+    # if your distro is a arch flavor
     sudo pacman -S base-devel libusb libusb-compat libusb-devel make gcc
 
 Step (1) - OSX
@@ -90,7 +97,7 @@ Finally we can clone and install python-seabreeze:
     cd python-seabreeze
     python -m pip install .
 
-This should install python-seabreeze in your python environment.
+This should install seabreeze in your python environment.
 
 
 Operating System dependent setup
@@ -101,9 +108,21 @@ running the script provided by python-seabreeze. After installing via pip, run:
 
 .. code:: bash
 
-    $ seabreeze_os_setup
+    seabreeze_os_setup
 
 For some additional information see
 `os_support/readme.md <https://github.com/ap--/python-seabreeze/blob/master/os_support/readme.md>`_.
 
 
+Installing on a Raspberry Pi
+----------------------------
+
+Rasperry Pi wheels are automagically provided by the wonderful
+`piwheels package repository <https://www.piwheels.org/project/seabreeze/>`_. Follow the
+instructions `here <https://www.piwheels.org/>`_ on how to add piwheels as an extra index
+to pip and then you should be able to install via:
+
+.. code:: bash
+
+    pip3 install seabreeze
+

docs/source/tldr.rst

@@ -6,14 +6,9 @@ You know how to install python modules with binary extensions and you know how t
 access usb devices from user space with your operating system of choice. Here's
 all you need to know to read a spectrum:
 
-.. danger::
-
-    Until version v1.0.0 is fully released pip install requires the `--pre` argument to install
-    the pypi prerelease.
-
 .. code:: bash
 
-    $ pip install seabreeze --pre
+    $ pip install seabreeze
 
 
 Do the os specific setup:

docs/source/troubleshoot.rst

@@ -3,7 +3,7 @@ Troubleshooting
 
 .. _troubleshoot:
 
-Some common issues you might have with python-seabreeze
+Some common issues you might have with seabreeze
 
 No spectrometer is detected
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^