Setup lint and test (#1)

* initial commit

* fix pip install

Author: harupy

.flake8

@@ -0,0 +1,2 @@
+[flake8]
+max-line-length=100

.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  pull_request:
+    branches:
+      - master
+  push:
+    branches:
+      - master
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-python@v1
+        with:
+          python-version: 3.7
+      - run: pip install -e ".[dev]"
+      - run: flake8 .
+      - run: isort --check-only .
+      - run: black --check .
+
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-python@v1
+        with:
+          python-version: 3.7
+      - run: pip install -e ".[dev]"
+      - run: pytest tests

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?= -W --keep-going
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/source/conf.py

@@ -0,0 +1,57 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+# import os
+# import sys
+# sys.path.insert(0, os.path.abspath('.'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = "sphinx-plotly-directive"
+copyright = "2020, harupy"
+author = "harupy"
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
+    "sphinx_rtd_theme",
+    "sphinx_plotly_directive",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = []
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "alabaster"
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ["_static"]

docs/source/index.rst

@@ -0,0 +1,20 @@
+.. sphinx-plotly-directive documentation master file, created by
+   sphinx-quickstart on Mon Oct 19 19:57:50 2020.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to sphinx-plotly-directive's documentation!
+===================================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

pyproject.toml

@@ -0,0 +1,8 @@
+[tool.black]
+line-length = 100
+
+[tool.isort]
+profile = 'black'
+skip_glob = ['docs/source/conf.py']
+line_length = 100
+lines_after_imports = 2

pytest.ini

@@ -0,0 +1,2 @@
+[pytest]
+addopts = --color=yes --durations=5 --showlocals

setup.py

@@ -0,0 +1,65 @@
+import os
+import re
+
+from setuptools import find_packages, setup
+
+
+PACKAGE_NAME = "sphinx-plotly-directive"
+GITHUB_REPO_URL = "https://github.com/harupy/{}".format(PACKAGE_NAME)
+ROOT = os.path.abspath(os.path.dirname(__file__))
+
+
+def extract_version(line):
+    return re.search(r'__version__ = "(.+)"', line).group(1)
+
+
+def get_version():
+    version_filepath = os.path.join(ROOT, PACKAGE_NAME.replace("-", "_"), "version.py")
+    with open(version_filepath) as f:
+        for line in f:
+            if line.startswith("__version__"):
+                return extract_version(line)
+
+    # should not reach this line
+    assert False
+
+
+def get_readme():
+    with open(os.path.join(ROOT, "README.md"), encoding="utf-8") as f:
+        return f.read()
+
+
+def get_install_requires():
+    return ["plotly"]
+
+
+def get_extras_require():
+    return {
+        "dev": [
+            # code formatting
+            "flake8",
+            "isort",
+            "black",
+            # test
+            "pytest",
+            # document
+            "sphinx==3.0.4",
+            "sphinx-rtd-theme",
+        ]
+    }
+
+
+setup(
+    name=PACKAGE_NAME,
+    version=get_version(),
+    packages=find_packages(),
+    python_requires=">=3.6",
+    install_requires=get_install_requires(),
+    extras_require=get_extras_require(),
+    maintainer="harupy",
+    maintainer_email="hkawamura0130@gmail.com",
+    url=GITHUB_REPO_URL,
+    description="A directive for including a plotly figure in a Sphinx document",
+    long_description=get_readme(),
+    long_description_content_type="text/markdown",
+)

sphinx_plotly_directive/version.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"