deckbridge 0.1.0__tar.gz

deckbridge-0.1.0/.bumpversion.cfg

@@ -0,0 +1,6 @@
+[bumpversion]
+current_version = 0.1.0
+
+[bumpversion:file:src/deckbridge/_version.py]
+
+[bumpversion:file:conda_recipe/meta.yaml]

deckbridge-0.1.0/.coveragerc

@@ -0,0 +1,8 @@
+[run]
+omit =
+  tests/*
+  src/deckbridge/_version.py
+  src/deckbridge/_git_version.py
+
+[report]
+show_missing = True

deckbridge-0.1.0/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0
+
+The initial setup of this project.

deckbridge-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Joseph Cobb
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

deckbridge-0.1.0/MANIFEST.in

@@ -0,0 +1,24 @@
+include *.ini
+include *.md
+include *.py
+include *.rst
+include *.sh
+include *.txt
+include *.toml
+include *.yml
+
+include .bumpversion.cfg
+include .coveragerc
+include Makefile
+
+recursive-include conda_recipe *.yaml
+recursive-include docs *.py
+recursive-include docs *.rst
+recursive-include tests *.py
+
+recursive-include src *.pptx
+recursive-include src *.sql
+recursive-include src *.yml
+recursive-include src *.yaml
+
+prune .ipynb_checkpoints

deckbridge-0.1.0/Makefile

@@ -0,0 +1,15 @@
+SHELL := /bin/bash
+
+sphinx:
+				@ . make_docs.sh
+
+ghpages:
+				rm -R -f docs_temp && \
+				cp -r docs/ docs_temp/ && \
+				git checkout gh-pages && \
+				rm -R -f docs/ && \
+				cp -r docs_temp/ docs/ && \
+				rm -R -f docs_temp/ && \
+				git add -u && \
+				git add -A && \
+				PRE_COMMIT_ALLOW_NO_CONFIG=1 git commit -m "Updated generated Sphinx documentation"

deckbridge-0.1.0/PKG-INFO

@@ -0,0 +1,82 @@
+Metadata-Version: 2.4
+Name: deckbridge
+Version: 0.1.0
+Summary: Deck builder for analytics.
+Author-email: Joseph Cobb <josephxcobb@gmail.com>
+Project-URL: repository, https://github.com/josephcobb111/deckbridge
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.9
+Requires-Python: >=3.9
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+Requires-Dist: google-api-python-client
+Requires-Dist: google-auth
+Requires-Dist: google-auth-httplib2
+Requires-Dist: google-auth-oauthlib
+Requires-Dist: pandas
+Requires-Dist: python-pptx
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: furo; extra == "docs"
+Requires-Dist: myst-parser; extra == "docs"
+Provides-Extra: tests
+Requires-Dist: coverage; extra == "tests"
+Requires-Dist: mypy; extra == "tests"
+Requires-Dist: pytest>=6.0; extra == "tests"
+Requires-Dist: pytest-cov; extra == "tests"
+Requires-Dist: pyyaml; extra == "tests"
+Requires-Dist: types-pyyaml; extra == "tests"
+Provides-Extra: qa
+Requires-Dist: check-manifest; extra == "qa"
+Requires-Dist: pre-commit; extra == "qa"
+Requires-Dist: pre-commit-hooks; extra == "qa"
+Requires-Dist: mypy; extra == "qa"
+Requires-Dist: edgetest; extra == "qa"
+Requires-Dist: ruff; extra == "qa"
+Requires-Dist: black; extra == "qa"
+Requires-Dist: flake8; extra == "qa"
+Requires-Dist: isort; extra == "qa"
+Requires-Dist: pylint; extra == "qa"
+Provides-Extra: build
+Requires-Dist: twine; extra == "build"
+Requires-Dist: wheel; extra == "build"
+Requires-Dist: bump2version; extra == "build"
+Provides-Extra: dev
+Requires-Dist: deckbridge[docs]; extra == "dev"
+Requires-Dist: deckbridge[tests]; extra == "dev"
+Requires-Dist: deckbridge[qa]; extra == "dev"
+Requires-Dist: deckbridge[build]; extra == "dev"
+Dynamic: license-file
+
+# deckbridge
+
+[![image](https://img.shields.io/badge/python-3.9-green.svg)](https://www.python.org)
+[![image](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+
+## Quick Start
+
+Create a virtual environment with Python 3.9 and install from git:
+
+```
+pip install git+ssh://git@github.com/josephcobb111/deckbridge.git
+```
+
+## Documentation
+
+Full documentation is available on [GitHub Pages](https://github.com/josephcobb111/deckbridge/build/html/index.html)
+
+## Bugs / Requests
+Please use the [GitHub issue tracker](https://github.com/josephcobb111/deckbridge/issues) to submit bugs or request features.
+
+## Changelog
+
+Consult the [Changelog](https://github.com/josephcobb111/deckbridge/build/html/changelog.html) for the latest release information.
+
+# Changelog
+
+## 0.1.0
+
+The initial setup of this project.

deckbridge-0.1.0/README.md

@@ -0,0 +1,24 @@
+# deckbridge
+
+[![image](https://img.shields.io/badge/python-3.9-green.svg)](https://www.python.org)
+[![image](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+
+## Quick Start
+
+Create a virtual environment with Python 3.9 and install from git:
+
+```
+pip install git+ssh://git@github.com/josephcobb111/deckbridge.git
+```
+
+## Documentation
+
+Full documentation is available on [GitHub Pages](https://github.com/josephcobb111/deckbridge/build/html/index.html)
+
+## Bugs / Requests
+Please use the [GitHub issue tracker](https://github.com/josephcobb111/deckbridge/issues) to submit bugs or request features.
+
+## Changelog
+
+Consult the [Changelog](https://github.com/josephcobb111/deckbridge/build/html/changelog.html) for the latest release information.

deckbridge-0.1.0/build_conda.sh

@@ -0,0 +1,15 @@
+conda create -n conda_build python=3.9 boa conda-build -y
+conda activate conda_build
+rm -R -f conda-pkg
+mkdir conda-pkg
+conda build conda_recipe/ --output-folder conda-pkg
+conda install -c file://${HOME}/deckbridge/conda-pkg/ deckbridge -y
+conda install pytest pytest-cov flake8 -y
+pytest
+
+# To upload to cloud
+# anaconda login
+# anaconda upload <PATH-TO-PACKAGE>.tar.bz2
+# e.g.,
+# anaconda login
+# anaconda upload conda-pkg/noarch/deckbridge-0.1.0-py_0.tar.bz2 

deckbridge-0.1.0/conda_recipe/meta.yaml

@@ -0,0 +1,28 @@
+package:
+  name: deckbridge
+  version: "0.1.0"
+
+source:
+  path: ../
+
+build:
+  noarch: python
+  number: 0
+  script: python -m pip install --no-deps --ignore-installed .
+
+requirements:
+  host:
+    - python
+    - setuptools
+  run:
+    - python>=3.9
+    - google-api-python-client
+    - google-auth
+    - google-auth-httplib2
+    - google-auth-oauthlib
+    - pandas
+    - python-pptx
+
+test:
+  imports:
+    - pandas

deckbridge-0.1.0/docs/source/api/deckbridge.getting_started.rst

@@ -0,0 +1,7 @@
+deckbridge.getting\_started module
+===================================
+
+.. automodule:: deckbridge.getting_started
+   :members:
+   :undoc-members:
+   :show-inheritance:

deckbridge-0.1.0/docs/source/api/deckbridge.rst

@@ -0,0 +1,15 @@
+deckbridge package
+===================
+
+.. automodule:: deckbridge
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Submodules
+----------
+
+.. toctree::
+   :maxdepth: 4
+
+   deckbridge.getting_started

deckbridge-0.1.0/docs/source/api/modules.rst

@@ -0,0 +1,7 @@
+deckbridge
+===========
+
+.. toctree::
+   :maxdepth: 4
+
+   deckbridge

deckbridge-0.1.0/docs/source/conf.py

@@ -0,0 +1,171 @@
+"""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 anotehr 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 importlib.metadata as metadata
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath(".."))
+
+# -- Project information --------------------------------------------------------------------------
+
+project = "deckbridge"
+copyright = "MIT License"
+author = "Joseph Cobb"
+release = metadata.version("deckbridge")
+
+# -- General configuration ------------------------------------------------------------------------
+
+# If your documentation needs a minimal sphinx version, state it here.
+
+# needs_sphinx = '1.0'
+
+# 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.doctest",
+    "sphinx.ext.todo",
+    "sphinx.ext.coverage",
+    "sphinx.ext.imgmath",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.githubpages",
+    "sphinx.ext.napoleon",
+    "myst_parser",
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+# The defaults are to use RST which is fine for this configuration.
+source_suffix = [".rst", ".md"]
+
+# THe master toctree document
+master_doc = "index"
+
+# The language for content autogenerated by Sphinx.
+# Refer to documentation for a list of supported languages
+
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" fro mthe command line for these cases.
+
+# 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 = ["_build", "Thumbs.db", ".DS_Store"]
+
+# The name of the Pygments (syntax highlighting) style to use.
+# The read-the-doc theme has good defaults with a light color.
+# If you want the yellow highlight uncomment the style for sphinx below.
+# pygments_style = 'sphinx'
+
+# -- 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 = "furo"
+html_title = "deckbridge"
+
+# 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"]
+
+# Custom sidebar templates, must be a dictionary that maps document names to template names.
+
+# The default sidebars (for documents that don't match any pattern) are defined by theme itself.
+# Builtin themes are using these templates by default:
+# ``['localtoc.html', 'relations.html', 'sourcelink.html', 'searchbox.html']``
+
+# This is required for the alabaster theme
+# refs: http://alabaster.readthedocs/io/en/latest/installation.html#sidebars
+
+# -- Options for HTMLHelp output ------------------------------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "deckbridgedoc"
+
+# -- Options for LaTeX output ---------------------------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper')
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt')
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    # 'preamble': '',
+    # LaTeX figure (float) alignment
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files.
+# List of tuples (source start file, target name, title, author, documentclass [howto, manual, or own class])
+latex_documents = [
+    (
+        "latex_index",  # this uses a separate section from index.rst
+        "deckbridge.tex",
+        "deckbridge Documentation",
+        "Joseph Cobb",
+        "manual",
+    )
+]
+
+latex_logo = ""
+
+# For "manual" documents, if this is true, then toplevel headings are parts, not chapters.
+# latex_use_parts = True
+
+# If true, show page references after internal links.
+latex_show_pagerefs = True
+
+# If true, show URL addresses after external links.
+# latex_show_urls = False
+
+# Additional stuff for the LaTeX preamble.
+# latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+# latex_appendices = []
+
+# If false, no module index is generated.
+latex_domain_indices = False
+
+# -- Options for manual page output ---------------------------------------------------------------
+
+# One entry per manual page.
+# List of tuples (source start file, name, description, authors, manual section)
+man_pages = [(master_doc, "deckbridge", "deckbridge Documentation", [author], 1)]
+
+# -- Options for Texinfo output -------------------------------------------------------------------
+
+# Grouping the document tree into Texinfo files.
+# List of tuples (source start file, target name, title author, dir menu entry, description, category)
+texinfo_documents = [
+    (
+        master_doc,
+        "deckbridge",
+        "deckbridge Documentation",
+        author,
+        "deckbridge",
+        "One line description of project",
+        "Miscellaneous",
+    )
+]
+
+# -- Extension configuration ----------------------------------------------------------------------
+
+# -- Options for todo extension -------------------------------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True
+
+# -- Options for myst headings --------------------------------------------------------------------
+myst_heading_anchors = 3

deckbridge-0.1.0/environment.yml

@@ -0,0 +1,13 @@
+name: deckbridge
+channels:
+    - conda-gurobi
+    - conda-shared
+    - conda-forge
+dependencies:
+    - python>=3.9
+    - google-api-python-client
+    - google-auth
+    - google-auth-httplib2
+    - google-auth-oauthlib
+    - pandas
+    - python-pptx

deckbridge-0.1.0/make_docs.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+
+cd docs
+make clean html latexpdf
+cd ../
+echo "Execution complete"

deckbridge-0.1.0/pyproject.toml

@@ -0,0 +1,207 @@
+[project]
+name = "deckbridge"
+requires-python = ">=3.9"
+description = "Deck builder for analytics."
+authors = [
+    {name = "Joseph Cobb", email = "josephxcobb@gmail.com"}
+]
+classifiers = [
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.9",
+]
+
+dynamic = ["readme", "version", "dependencies"]
+
+[project.optional-dependencies]
+docs = [
+    "sphinx",
+    "furo",
+    "myst-parser",
+]
+tests = [
+    "coverage",
+    "mypy",
+    "pytest>=6.0",
+    "pytest-cov",
+    "pyyaml",
+    "types-pyyaml",
+]
+qa = [
+    "check-manifest",
+    "pre-commit",
+    "pre-commit-hooks",
+    "mypy",
+    "edgetest",
+    "ruff",
+    "black",
+    "flake8",
+    "isort",
+    "pylint",
+]
+build = [
+    "twine",
+    "wheel",
+    "bump2version",
+]
+dev = [
+    "deckbridge[docs]",
+    "deckbridge[tests]",
+    "deckbridge[qa]",
+    "deckbridge[build]",
+]
+
+[project.urls]
+repository = "https://github.com/josephcobb111/deckbridge"
+
+# The build system using setuptools allows pip to work for these projects.
+[build-system]
+requires = ["setuptools>=64.0.0"]
+build-backend = "setuptools.build_meta"
+
+###################################################################################################
+# Setuptools Configuration
+###################################################################################################
+
+# This is currently a default behavior of pyproject.toml, but we're trying to be explicit.
+# You still need the MANIFEST.in file.
+# See: https://setuptools.pypa.io/en/latest/userguide/datafiles.html
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.dynamic]
+version = {attr = "deckbridge.__version__"}
+readme = {file = ["README.md", "CHANGELOG.md"]}
+dependencies = {file = "requirements.txt"}
+
+# Both flat and src layouts are supported by default. This makes it explicit.
+# https://setuptools.pypa.io/en/latest/userguide/pyproject_config.html#setuptools-specific-configuration
+[tool.setuptools.packages.find]
+where = ["src"]
+
+###################################################################################################
+# Dev Tooling Configuration
+###################################################################################################
+
+# CHECK-MANIFEST ----------------------------------------------------------------------------------
+[tool.check-manifest]
+ignore = [
+    "docs",
+    "docs/**",
+    "notebooks",
+    "notebooks/**",
+    "setup",
+    "setup/**",
+    ".pre-commit-config.yaml",
+]
+
+# EDGETEST ----------------------------------------------------------------------------------------
+[edgetest]
+deps = "-r requirements.txt"
+extras = "tests"
+command = "pytest --cov-fail-under=0"  # TO DO: make coverage compatible
+
+# MYPY --------------------------------------------------------------------------------------------
+[tool.mypy]
+warn_return_any = true
+warn_unused_configs = true
+ignore_missing_imports = true
+
+# PYTEST ------------------------------------------------------------------------------------------
+[tool.pytest.ini_options]
+minversion = "6.0"
+addopts = "--cov=src -vv -ra --cov-report=html --verbose --cov-fail-under=80"
+testpaths = ["tests"]
+markers = [
+    "quality: code quality tests",
+]
+
+# See: https://docs.astral.sh/ruff/rules/
+[tool.ruff]
+#extend-include = ["*.ipynb"] # enable linting within notebook cells
+target-version = "py39"
+src = ["src"]
+line-length = 140
+
+[tool.ruff.lint]
+preview = true
+select = [
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    "D",  # pydocstyle
+    "I",  # isort
+    "C",  # flake8-comprehensions
+    "TID252",  # flake8-tidy-imports ban relative imports
+    #"T20",  # flake8-print
+    #"UP",  # pyupgrade
+    #"B",  # flake8-bugbear
+    #"A",  # flake8-builtins
+    #"C901",  # mccabe complexity
+    #"G",  # flake8-logging-format
+    #"ARG",  # flake8-unused-arguments
+    #"SIM",  # flake8-simplify
+    #"NPY",  # numpy rules
+    #"LOG",  # flake8-logging
+    #"RUF",  # Ruff errors
+]
+
+ignore = [
+    "E111",  # Check indentation level. Using formatter instead.
+    "E114",  # Check indentation level. Using formatter instead.
+    "E117",  # Check indentation level. Using formatter instead.
+    "E203",  # Check whitespace. Using formatter instead.
+    "E501",  # Line too long. Using formatter instead.
+    "D206",  # Docstring indentation. Using formatter instead.
+    "D300",  # Use triple single quotes. Using formatter instead.
+    "D416",  # Section names ends in colon, we have the underlines in place.
+    "SIM108",  # Use ternary operator instead of if-else blocks.
+    "SIM105",  # Use `contextlib.suppress(FineNotFoundError)` instead of `try`-`except`-`pass`.
+    "UP035",  # `typing.x` is deprecated, use `x` instead.
+    "UP006",  # `typing.x` is deprecated, use `x` instead.
+    "C901",  # McCabe complexity
+]
+
+[tool.ruff.lint.per-file-ignores]
+"__init__.py" = ["E402", "F401"]
+"**/{tests,docs}/*" = ["E402", "D", "F841", "ARG", "T20"]
+
+[tool.ruff.lint.flake8-tidy-imports]
+ban-relative-imports = "all"
+
+[tool.ruff.lint.pydocstyle]
+convention = "google"
+
+# ISORT ------------------------------------------------------------------------------------------
+[tool.isort]
+profile = "black"
+multi_line_output = 3
+include_trailing_comma = true
+force_grid_wrap = 0
+use_parentheses = true
+line_length = 140
+
+# PYLINT ------------------------------------------------------------------------------------------
+[tool.pylint.master]
+ignore-paths = "^docs/,tests/,versioneer.py,src/deckbridge/_git_version.py"
+
+[tool.pylint.format]
+# Regexp for a line that is allowed to be longer than the limit
+ignore-long-lines = "^\\s*(# )?<?https:?://\\S+>?$"
+max-line-length = 140
+
+[tool.pylint.logging]
+# The type of string formatting that logging methods do. `old` means using % formatting, `new` is for `{}` formatting
+logging-format-style = "new"
+
+[tool.pylint.main]
+fail-under = 9.5
+
+[tool.pylint."messages control"]
+disable = ["unspecified-encoding", "logging-too-many-args", "logging-fstring-interpolation", "too-few-public-methods"]
+good-names = ["df", "f"]
+
+[tool.pylint.miscellaneous]
+# List of note tags to take in consideration, separated by a comma
+notes = ["FIXME", "XXX", "TODO"]

deckbridge-0.1.0/requirements.txt

@@ -0,0 +1,6 @@
+google-api-python-client
+google-auth
+google-auth-httplib2
+google-auth-oauthlib
+pandas
+python-pptx