From 2f91ce0367dcbfb8dd0c6240360926f6c668b09e Mon Sep 17 00:00:00 2001 From: Merrick Rumel Date: Wed, 15 Jun 2022 10:17:19 -0400 Subject: [PATCH] Initial setup of directory structure --- .gitignore | 8 ++++++ MANIFEST.in | 9 ++++++ README.md => README.rst | 0 docs/Makefile | 20 ++++++++++++++ docs/make.bat | 35 +++++++++++++++++++++++ docs/source/conf.py | 55 +++++++++++++++++++++++++++++++++++++ docs/source/index.rst | 20 ++++++++++++++ examples/example.py | 0 requirements.txt | 1 + setup.cfg | 21 ++++++++++++++ setup.py | 3 ++ src/TCAN4550-py/__init__.py | 0 tests/__init__.py | 0 tox.ini | 13 +++++++++ 14 files changed, 185 insertions(+) create mode 100644 .gitignore create mode 100644 MANIFEST.in rename README.md => README.rst (100%) create mode 100644 docs/Makefile create mode 100644 docs/make.bat create mode 100644 docs/source/conf.py create mode 100644 docs/source/index.rst create mode 100644 examples/example.py create mode 100644 requirements.txt create mode 100644 setup.cfg create mode 100644 setup.py create mode 100644 src/TCAN4550-py/__init__.py create mode 100644 tests/__init__.py create mode 100644 tox.ini diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9dcd9a6 --- /dev/null +++ b/.gitignore @@ -0,0 +1,8 @@ +*.pyc +.pytest_cache +.vscode +build +dist +__pycache__ +*.egg-info +_build \ No newline at end of file diff --git a/MANIFEST.in b/MANIFEST.in new file mode 100644 index 0000000..f0b8a72 --- /dev/null +++ b/MANIFEST.in @@ -0,0 +1,9 @@ +include setup.py +include MANIFEST.in +include LICENSE +include README.md + +graft tests +graft examples +graft docs +graft src \ No newline at end of file diff --git a/README.md b/README.rst similarity index 100% rename from README.md rename to README.rst diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/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 ?= +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) diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 0000000..dc1312a --- /dev/null +++ b/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 + +%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.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..434cacf --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,55 @@ +# 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 = 'TCAN4550-py' +copyright = '2022, Merrick Rumel' +author = 'Merrick Rumel' + +# The full version, including alpha/beta/rc tags +release = '0.0.0' + + +# -- 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 = [ +] + +# 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'] \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..de4ea9b --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,20 @@ +.. TCAN4550-py documentation master file, created by + sphinx-quickstart on Wed Jun 15 10:15:53 2022. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to TCAN4550-py's documentation! +======================================= + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/examples/example.py b/examples/example.py new file mode 100644 index 0000000..e69de29 diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..ecf975e --- /dev/null +++ b/requirements.txt @@ -0,0 +1 @@ +-e . \ No newline at end of file diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..d23155e --- /dev/null +++ b/setup.cfg @@ -0,0 +1,21 @@ +[metadata] +name = TCAN4550-py +version = 0.0.0 +license = MIT +description = This repository is to provide methods to easily control the TCAN4550 from Texas Instruments +long_description = file: README.rst +author = Merrick Rumel +author_email = merrick.rumel@gmail.com +classifiers= + Development Status :: 3 - Alpha + +[options] +packages = find: +package_dir = + =src +include_package_data = True +install_requires = + + +[options.packages.find] +where=src \ No newline at end of file diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..fc1f76c --- /dev/null +++ b/setup.py @@ -0,0 +1,3 @@ +from setuptools import setup + +setup() \ No newline at end of file diff --git a/src/TCAN4550-py/__init__.py b/src/TCAN4550-py/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tox.ini b/tox.ini new file mode 100644 index 0000000..ce57b8f --- /dev/null +++ b/tox.ini @@ -0,0 +1,13 @@ +[tox] +envlist = + py38 + py39 + py310 + +[testenv] +deps = + pytest + pytest-cov + pytest-randomly +commands = + pytest --cov= --randomly-seed=1 \ No newline at end of file