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

.gitignore

@@ -131,4 +131,4 @@ dmypy.json
 
 # temp files
 ~$*.*
-tests/input_files/headless_export/output/
+#tests/input_files/headless_export/output/

.readthedocs.yaml

@@ -0,0 +1,31 @@
+# .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"
+  apt_packages:
+    - graphviz
+
+# 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,42 @@
+language: python
+job:
+  include:
+    #- python: "3.8"
+    #  env: 
+    #    - TOXENV=py38
+    #- python: "3.9"
+    #  env: 
+    #    - TOXENV=py39
+    - python: "3.10"
+      dist: focal
+      env: 
+        - TOXENV=py310
+        - YARN_GPG=no
+    - python: "3.11"
+      dist: bionic
+      env: 
+        - TOXENV=py311
+        - YARN_GPG=no
+    - python: "3.10"
+      dist: focal
+      env: 
+        - TOXENV=coverage
+        - YARN_GPG=no
+    - python: "3.10"
+      dist: focal
+      env: 
+        - TOXENV=docs
+        - YARN_GPG=no
+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 -n auto
+after_success:
+  - if [[ -e .coverage ]]; then ./codecov -t $CODECOV_TOKEN; fi

CHANGES.rst

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

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at software@insightindustry.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

LICENSE

@@ -0,0 +1 @@
+TODO: Add license details.