Merge pull request #2 from highcharts-for-python/enhancement/cicd-pipelines

Enhancement/cicd pipelines

Author: hcpchris

.github/workflows/pypi-publish.yml

@@ -0,0 +1,37 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# GitHub recommends pinning actions to a commit SHA.
+# To get a newer version, you will need to update the SHA.
+# You can also reference a tag or branch, but the action may change without warning.
+
+name: Release Library to PyPi
+
+on:
+  release:
+    types: [published]
+
+env:
+  HATCH_INDEX_USER: __token__
+  HATCH_INDEX_AUTH: ${{ secrets.PYPI_API_TOKEN }}
+  HATCH_INDEX_REPO: main
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install hatch
+      - name: Build package
+        run: hatch build
+      - name: Publish package
+        run: hatch publish

.github/workflows/pypi-test-publish.yml

@@ -0,0 +1,38 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+# GitHub recommends pinning actions to a commit SHA.
+# To get a newer version, you will need to update the SHA.
+# You can also reference a tag or branch, but the action may change without warning.
+
+name: Upload Python Package
+
+on:
+  pull_request:
+    branches:
+      - master
+
+env:
+  HATCH_INDEX_USER: __token__
+  HATCH_INDEX_AUTH: ${{ secrets.TEST_PYPI_API_TOKEN }}
+  HATCH_INDEX_REPO: test
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.x'
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install hatch
+      - name: Build package
+        run: hatch build
+      - name: Publish package
+        run: hatch publish

.gitignore

@@ -50,6 +50,7 @@ coverage.xml
 *.py,cover
 .hypothesis/
 .pytest_cache/
+tests/pytest.ini
 
 # Translations
 *.mo
@@ -133,4 +134,4 @@ dmypy.json
 
 # temp files
 ~$*.*
-tests/input_files/headless_export/output/
+# tests/input_files/headless_export/output/

.readthedocs.yaml

@@ -0,0 +1,29 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+# formats:
+#    - pdf
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: requirements.dev.txt

.travis.yml

@@ -0,0 +1,36 @@
+language: python
+job:
+  include:
+    #- python: "3.8"
+    #  env: 
+    #    - TOXENV=py39
+    #    - HCP_BASIC_PYTEST=true
+    #- python: "3.9"
+    #  env: 
+    #    - TOXENV=py39
+    #    - HCP_BASIC_PYTEST=true
+    - python: "3.10"
+      dist: focal
+      env: TOXENV=py310
+    - python: "3.11"
+      dist: bionic
+      env: TOXENV=py311
+    - python: "3.10"
+      dist: focal
+      env: TOXENV=coverage
+    - python: "3.10"
+      dist: focal
+      env: TOXENV=docs
+os:
+  - linux
+git:
+  quiet: true
+
+install: 
+  - pip install -r requirements.dev.txt
+before_script:
+  - curl -Os --retry 5 https://uploader.codecov.io/latest/linux/codecov
+  - chmod +x codecov
+script: tox -- -v -nauto
+after_success:
+  - if [[ -e .coverage ]]; then ./codecov -t $CODECOV_TOKEN; fi

CHANGES.rst

@@ -1,4 +1,5 @@
-Release 0.1.0
+Release 1.0.0-rc1
 =========================================
 
-* First public release
+* First public release: **Release Candidate 1**
+

LICENSE

@@ -5,12 +5,12 @@ Highcharts Maps for Python
 **High-end data and map visualizations for the Python ecosystem**
 
 **Highcharts Maps for Python** is an extension to the
-`Highcharts for Python <https://highcharts-core.readthedocs.io>`__ library, and provides
+`Highcharts Core for Python <https://core-docs.highchartspython.com>`__ library, and provides
 a Python wrapper for the fantastic
 `Highcharts Maps <https://www.highcharts.com/products/maps/>`__
 JavaScript data visualization library. **Highcharts Maps for Python** also supports
 
-  * **Highcharts JS** - the core Highcharts data visualization library
+  * **Highcharts Core (JS)** - the core Highcharts data visualization library
   * The **Highcharts Export Server** - enabling the programmatic creation of static
     (downloadable) data visualizations
 
@@ -24,11 +24,11 @@ library features native integration with:
     dataframe.
   * **GeoPandas**. Automatically incorporate GIS / map visualizations with data from your
     GeoPandas GeoDataFrames.
-  * **Topojson**. Automatically visualizes :term:`TopoJSON` :term:`map geometries <map geometry>`.
-  * **Geojson**. Automatically visualizes :term:`GeoJSON` :term:`map geometries <map geometry>`.
+  * **Topojson**. Automatically visualizes TopoJSON map geometries.
+  * **Geojson**. Automatically visualizes GeoJSON map geometries.
 
 
-**COMPLETE DOCUMENTATION:** http://highcharts-maps.readthedocs.org/en/latest/index.html
+**COMPLETE DOCUMENTATION:** https://maps-docs.highchartspython.com/en/latest/index.html
 
 --------------------
 
@@ -75,7 +75,7 @@ capabilities to simplify integration with Javascript frontend frameworks (React,
 VueJS, etc.). But facilitating that with Highcharts has historically been very difficult.
 Part of this difficulty is because the Highcharts JavaScript suite - while supporting JSON
 as a serialization/deserialization format - leverages
-:term:`JavaScript object literals <JavaScript Object Literal Notation>` to expose the
+JavaScript object literals to expose the
 full power and interactivity of its data visualizations. And while it's easy to serialize
 JSON from Python, serializing and deserializing to/from JavaScript object literal notation
 is much more complicated. This means that Python developers looking to integrate with
@@ -89,19 +89,19 @@ So I wrote the **Highcharts for Python** toolkit to bridge that gap, and
 **Highcharts Maps for Python** provides support for
 the `Highcharts Maps <https://www.highcharts.com/products/maps/>`__ extension, which is
 designed to provide extensive time series data visualization capabilities optimized for
-:iabbr:`GIS (Geographic Information System)` data visualization, with
+GIS (Geographic Information System) data visualization, with
 robust interactivity. For ease of use, it also includes the full functionality of
-**Highcharts for Python** as well.
+**Highcharts Core for Python** as well.
 
 Key Highcharts Maps for Python Features
 ==============================================
 
-* **Clean and consistent API**. No reliance on "hacky" code, :class:`dict <python:dict>`
+* **Clean and consistent API**. No reliance on "hacky" code, ``dict``
   and JSON serialization, or impossible to maintain / copy-pasted "spaghetti code".
 * **Comprehensive Highcharts support**. Every single Highcharts chart type and every
   single configuration option is supported in **Highcharts Maps for Python**. This
   includes the over 70 data visualization types supported by
-  `Highcharts JS <https://www.highcharts.com/product/highcharts/>`__ and the
+  `Highcharts Core <https://www.highcharts.com/product/highcharts/>`__ and the
   four core map visualizations available in
   `Highcharts Maps <https://www.highcharts.com/product/maps/>`__, with full support for
   the rich JavaScript formatter (JS callback functions)
@@ -110,15 +110,14 @@ Key Highcharts Maps for Python Features
 
   .. seealso::
 
-    * :doc:`Supported Visualizations <visualizations>`
+    * `Supported Visualizations <https://maps-docs.highchartspython.com/en/latest/visualizations.html>`__
 
 * **Simple JavaScript Code Generation**. With one method call, produce production-ready
   JavaScript code to render your interactive visualizations using Highcharts' rich
   capabilities.
 * **Easy Chart Download**. With one method call, produce high-end static
   visualizations that can be downloaded or shared as files with your audience. Produce
-  static charts using the Highsoft-provided
-  :term:`Highcharts Export Server <Export Server>`, or using your own private export
+  static charts using the Highsoft-provided **Highcharts Export Server**, or using your own private export
   server as needed.
 * **Asynchronous Map Data Retrieval**. To minimize the amount of data transferred over
   the wire, **Highcharts Maps for Python** has built-in support for the configuration of
@@ -140,7 +139,7 @@ Key Highcharts Maps for Python Features
 ===================================================
 
 For a discussion of **Highcharts Maps for Python** in comparison to alternatives, please see
-the **COMPLETE DOCUMENTATION:** http://highcharts-maps.readthedocs.org/en/latest/index.html
+the **COMPLETE DOCUMENTATION:** https://maps-docs.highchartspython.com/en/latest/index.html
 
 ---------------------
 
@@ -151,47 +150,35 @@ Hello World, and Basic Usage
 1. Import Highcharts Maps for Python
 ==========================================
 
-.. tabs::
+.. code-block:: python
 
-  .. tab:: from Precise Location
+  # PRECISE IMPORT PATTERN  
+  # This method of importing Highcharts Maps for Python objects yields the fastest
+  # performance for the import statement. However, it is more verbose and requires
+  # you to navigate the extensive Highcharts Maps for Python API.
 
-    .. tip::
+  # Import classes using precise module indications. For example:
+  from highcharts_maps.chart import Chart
+  from highcharts_maps.global_options.shared_options import SharedMapsOptions
+  from highcharts_maps.options import HighchartsMapsOptions
+  from highcharts_maps.options.plot_options.map import MapOptions
+  from highcharts_maps.options.series.map import MapSeries
 
-      **Best Practice!**
+  # CATCH-ALL IMPORT PATTERN
+  # This method of importing Highcharts Maps for Python classes has relatively slow
+  # performance because it imports hundreds of different classes from across the entire
+  # library. This is also a known anti-pattern, as it obscures the namespace within the
+  # library. Both may be acceptable to you in your use-case, but do use at your own risk.
 
-      This method of importing **Highcharts Maps for Python** objects yields the fastest
-      performance for the ``import`` statement. However, it is more verbose and requires
-      you to navigate the extensive :doc:`Highcharts Maps for Python API </api>`.
+  # Import objects from the catch-all ".highcharts" module.
+  from highcharts_maps import highcharts
 
-    .. code-block:: python
-
-      # Import classes using precise module indications. For example:
-      from highcharts_maps.chart import Chart
-      from highcharts_maps.global_options.shared_options import SharedMapsOptions
-      from highcharts_maps.options import HighchartsMapsOptions
-      from highcharts_maps.options.plot_options.map import MapOptions
-      from highcharts_maps.options.series.map import MapSeries
-
-  .. tab:: from ``.highcharts``
-
-    .. caution::
-
-      This method of importing **Highcharts Maps for Python** classes has relatively slow
-      performance because it imports hundreds of different classes from across the entire
-      library. This is also a known anti-pattern, as it obscures the namespace within the
-      library. Both may be acceptable to you in your use-case, but do use at your own risk.
-
-    .. code-block:: python
-
-      # Import objects from the catch-all ".highcharts" module.
-      from highcharts_stock import highcharts
-
-      # You can now access specific classes without individual import statements.
-      highcharts.Chart
-      highcharts.SharedMapsOptions
-      highcharts.HighchartsMapsOptions
-      highcharts.MapOptions
-      highcharts.MapSeries
+  # You can now access specific classes without individual import statements.
+  highcharts.Chart
+  highcharts.SharedMapsOptions
+  highcharts.HighchartsMapsOptions
+  highcharts.MapOptions
+  highcharts.MapSeries
 
 
 2. Create Your Chart
@@ -356,12 +343,23 @@ that will render the chart wherever it is you want it to go:
 
 --------------
 
-*********************
-Questions and Issues
-*********************
+***********************
+Getting Help/Support
+***********************
 
-You can ask questions and report issues on the project's
-`Github Issues Page <https://github.com/hcpllc/highcharts-maps/issues>`_
+The **Highcharts for Python** toolkit comes with all of the great support that you are used to from working with the 
+Highcharts JavaScript libraries. When you license the toolkit, you are welcome to use any of the following tools to get 
+help using the toolkit. In particular, you can:
+
+  * Use the `Highcharts Forums <https://highcharts.com/forum>`__
+  * Use `Stack Overflow <https://stackoverflow.com/questions/tagged/highcharts-for-python>`__ with the 
+    ``highcharts-for-python`` tag
+  * `Report bugs or request features <https://github.com/highcharts-for-python/highcharts-maps/issues>`__  in the 
+    library's Github repository
+  * `File a support ticket <https://www.highchartspython.com/get-help>`__ with us
+  * `Schedule a live chat or video call <https://www.highchartspython.com/get-help>`__ with us
+
+**FOR MORE INFORMATION:** https://www.highchartspython.com/get-help
 
 -----------------
 
@@ -370,18 +368,15 @@ Contributing
 *********************
 
 We welcome contributions and pull requests! For more information, please see the
-:doc:`Contributor Guide <contributing>`. And thanks to all those who've already
-contributed:
-
-.. include:: _contributors.rst
+`Contributor Guide <https://maps-docs.highchartspython.com/en/latest/contributing.html>`__. And thanks to all those who've already contributed!
 
 -------------------
 
 *********************
 Testing
 *********************
 
-We use `TravisCI <http://travisci.org>`_ for our build automation and
+We use `TravisCI <https://travisci.org>`_ for our build automation and
 `ReadTheDocs <https://readthedocs.org>`_ for our documentation.
 
 Detailed information about our test suite and how to run tests locally can be