Merge pull request #11 from highcharts-for-python/develop

PR for v.1.0.0-rc1

Author: hcpchris

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: File a bug report to help us improve
+title: BUG
+labels: bug
+assignees: hcpchris
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. When I attempt '...' using the following code: '...'
+2. I receive '...'
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Your Environment:**
+ - OS: [e.g. Linux, Windows, etc.]
+ - Python Version: [e.g. 3.10, 3.8, 3.11]
+ - Highcharts JavaScript Version: [e.g. 10.2, 10.3, etc.]
+
+**Additional context**
+Add any other context about the problem here.

.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

.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,33 @@
+language: python
+job:
+ include:
+ #- python: "3.8"
+ # env: TOXENV=py38
+ #- python: "3.9"
+ # env: TOXENV=py39
+ - 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:
+ - mkdir /home/travis/build/highcharts-for-python/highcharts-core/tests/input_files/headless_export/output/
+ - 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,4 @@
-Release 0.1.0
+Release 1.0.0-rc1
 =========================================
 
-* First public release
+* First public release: **Release Candidate 1**