plans 1.1.0.post1.dev0__tar.gz

plans-1.1.0.post1.dev0/.github/workflows/docs.yaml

@@ -0,0 +1,78 @@
+# DOCS WORKFLOW CONFIGURATION FILE
+# #######################################################################
+# Configuration file for build and deploy documentation in
+# GitHub CI services (GitHub Actions and GitHub Pages)
+
+
+# SETUP INSTRUCTIONS
+# ***********************************************************************
+# 1) check and config this file (if needed)
+# 2) push repo to main branch on GitHub
+# 3) if workflow passed: go to {Repo} -> Settings -> Pages and set the `gh-pages` as the deployment branch
+# 4) else if workflow failed: check out details where it failed and then try debug config files
+# Important config files:
+# - {repo}/.github/workflows/docs.yml (this file)
+# - {repo}/pyproject.toml (project dependencies, etc)
+# - {repo}/docs/conf.py (sphinx)
+# 5) If passed, the docs website will likely be live at https://{username}/github.io/{repo}
+
+
+# WORKFLOW FILE
+# ***********************************************************************
+
+# Workflow
+# =======================================================================
+name: docs
+
+# Triggers
+# =======================================================================
+on:
+  push:
+    branches: [ main ]  # Run whenever you push to main
+
+# Permissions
+# =======================================================================
+permissions:
+  contents: write  # Required for pushing to gh-pages
+
+# JOBS
+# =======================================================================
+jobs:
+  # BUILD JOB
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      # Step 1: Get your code
+      # -----------------------------------------------------------------
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # Step 2: Setup Python environment
+      # -----------------------------------------------------------------
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      # Step 3: Install project and docs dependencies
+      # -----------------------------------------------------------------
+      - name: Install dependencies
+        # V [CHECK THIS] use the appropriate package manager
+        run: |
+          python -m pip install --upgrade pip 
+          pip install .[docs]
+
+      # Step 4: Build Sphinx docs
+      # -----------------------------------------------------------------
+      - name: Build HTML
+        # V [CHECK THIS] this command may change depending on the package manager
+        run: |
+          sphinx-build -b html docs docs/_build/html
+
+      # Step 5: Deploy to GitHub Pages
+      # -----------------------------------------------------------------
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./docs/_build/html

plans-1.1.0.post1.dev0/.github/workflows/style.yaml

@@ -0,0 +1,57 @@
+# STYLE WORKFLOW CONFIGURATION FILE
+# #######################################################################
+# Configuration file for checking code style consistency
+# GitHub CI services (GitHub Actions and GitHub Pages)
+
+
+# WORKFLOW FILE
+# ***********************************************************************
+
+# Workflow
+# =======================================================================
+name: style
+
+# Triggers
+# =======================================================================
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+# Permissions
+# =======================================================================
+# no permissions
+
+# JOBS
+# =======================================================================
+jobs:
+  # BUILD JOB
+  black:
+    runs-on: ubuntu-latest
+    steps:
+      # Step 1: Get your code
+      # -----------------------------------------------------------------
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # Step 2: Setup Python environment
+      # -----------------------------------------------------------------
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'  # <-- [CHECK THIS] Specs the version you use locally
+
+      # Step 3: Install dev dependencies
+      # -----------------------------------------------------------------
+      - name: Install dependencies
+        # V [CHECK THIS] use the appropriate package manager
+        # V [CHECK THIS] black must be listed in pyproject.toml dev dependencies
+        run: |
+          python -m pip install --upgrade pip 
+          pip install black
+
+      # Step 4: Check black
+      # -----------------------------------------------------------------
+      - name: Run Black
+        run: black --check .

plans-1.1.0.post1.dev0/.github/workflows/tests.yaml

@@ -0,0 +1,57 @@
+# STYLE WORKFLOW CONFIGURATION FILE
+# #######################################################################
+# Configuration file for checking code style consistency
+# GitHub CI services (GitHub Actions and GitHub Pages)
+
+
+# WORKFLOW FILE
+# ***********************************************************************
+
+# Workflow
+# =======================================================================
+name: tests
+
+# Triggers
+# =======================================================================
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+# Permissions
+# =======================================================================
+# no permissions
+
+# JOBS
+# =======================================================================
+jobs:
+  # BUILD JOB
+  black:
+    runs-on: ubuntu-latest
+    steps:
+      # Step 1: Get your code
+      # -----------------------------------------------------------------
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # Step 2: Setup Python environment
+      # -----------------------------------------------------------------
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.11'
+
+      # Step 3: Install dev dependencies
+      # -----------------------------------------------------------------
+      - name: Install dependencies
+        # V [CHECK THIS] use the appropriate package manager
+        # V [CHECK THIS] include extra testing dependencies if needed
+        run: |
+          python -m pip install --upgrade pip 
+          pip install .
+
+      # Step 4: Run unit tests
+      # -----------------------------------------------------------------
+      - name: Run Tests
+        run: python -m unittest discover -s tests -p "test_*.py"

plans-1.1.0.post1.dev0/.gitignore

@@ -0,0 +1,285 @@
+# GIT IGNORE CONFIGURATION FILE
+########################################################################
+# This file sets everything that Git will NOT track in the project
+
+# CUSTOM IGNORE STATEMENTS
+# ***********************************************************************
+# [CHECK THIS] This section applies custom ignores that you may want to change
+
+# Files
+# =======================================================================
+
+# Local configs [CHECK THIS]
+# -----------------------------------------------------------------------
+.pre-commit-config.yaml
+# ... [ADD MORE IF NEEDED]
+
+# Non-sense script files
+# -----------------------------------------------------------------------
+bench*.py
+# ... [ADD MORE IF NEEDED]
+
+# Deprecated files conventions (e.g. '__mymodule.py')
+# -----------------------------------------------------------------------
+__*.*
+# exception to ignore
+!__init__.py
+# ... [ADD MORE IF NEEDED]
+
+# Heavy data files
+# -----------------------------------------------------------------------
+*.zip
+# ... [ADD MORE IF NEEDED]
+
+# Folders
+# =======================================================================
+
+# Docs
+# -----------------------------------------------------------------------
+# heavy assets
+docs/assets
+
+# Tests
+# -----------------------------------------------------------------------
+# any subfolder under tests/data/ is ignored
+tests/data/*/
+
+# outputs folder is fully ignored
+tests/outputs/
+# other tests folders
+/docs/datasets/
+/testing
+
+# Examples
+# -----------------------------------------------------------------------
+examples/outputs
+
+# Non-sense folders
+# -----------------------------------------------------------------------
+extra/
+misc/
+scripts/
+/_scripts/
+old/
+_aux/
+# ... [ADD MORE IF NEEDED]
+
+# PyCharm folders
+# -----------------------------------------------------------------------
+/.idea/
+
+
+# GITHUB STANDARD IGNORE STATEMENTS
+# ***********************************************************************
+# Below follows a template from GitHub
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+docs/generated
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer,
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+