boxyard 0.2.0__tar.gz

boxyard-0.2.0/.gitignore

@@ -0,0 +1,186 @@
+# Ignore nbs
+nbs/
+
+tmp_tests/
+__scratch/
+
+envname
+_proc/
+_docs/
+index_files/
+
+.DS_Store
+
+*.bak
+.gitattributes
+.last_checked
+.gitconfig
+*.bak
+*.log
+*~
+~*
+_tmp*
+tmp*
+tags
+*.pkg
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$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/
+
+# 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
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# 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
+.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/

boxyard-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Lukas Kikuchi
+
+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.

boxyard-0.2.0/PKG-INFO

@@ -0,0 +1,65 @@
+Metadata-Version: 2.4
+Name: boxyard
+Version: 0.2.0
+Summary: Add your description here
+License-File: LICENSE
+Requires-Python: >=3.11
+Requires-Dist: filelock>=3.12.0
+Requires-Dist: pydantic>=2.12.4
+Requires-Dist: python-ulid[pydantic]>=3.1.0
+Requires-Dist: rich>=14.2.0
+Requires-Dist: toml>=0.10.2
+Requires-Dist: typer>=0.20.0
+Description-Content-Type: text/markdown
+
+# boxyard
+
+<!-- #region -->
+# Usage
+
+To run all all scripts in `core` in sequence, run
+
+```python
+boxyard.core.run_all()
+```
+
+from within Python, or
+
+```
+boxyard run-core
+```
+
+from the terminal.
+<!-- #endregion -->
+
+<!-- #region -->
+# Development install instructions
+
+## Prerequisites
+
+- Install [uv](https://docs.astral.sh/uv/getting-started/installation/).
+- Install [direnv](https://direnv.net/) to automatically load the project virtual environment when entering it.
+    - Mac: `brew install direnv`
+    - Linux: `curl -sfL https://direnv.net/install.sh | bash`
+
+## Setting up the environment
+
+Run the following:
+
+```bash
+# In the root of the project folder
+uv sync # Installs the virtual environment at './.venv'
+direnv allow # Allows the automatic running of the script './.envrc'
+nbl install-hooks # Installs a git hooks that ensures that notebooks are added properly
+```
+
+You are now set up to develop the codebase.
+
+Further instructions:
+
+- To export notebooks run `nbl export`.
+- To clean notebooks run `nbl clean`.
+- To see other available commands run just `nbl`.
+- To add a new dependency run `uv add package-name`. See the the [uv documentation](https://docs.astral.sh/uv/) for more details.
+- You need to `git add` all 'twinned' notebooks for the commit to be validated by the git-hook. For example, if you add `nbs/my-nb.ipynb`, you must also add `pts/my-nb.pct.py`.
+<!-- #endregion -->

boxyard-0.2.0/README.md

@@ -0,0 +1,51 @@
+# boxyard
+
+<!-- #region -->
+# Usage
+
+To run all all scripts in `core` in sequence, run
+
+```python
+boxyard.core.run_all()
+```
+
+from within Python, or
+
+```
+boxyard run-core
+```
+
+from the terminal.
+<!-- #endregion -->
+
+<!-- #region -->
+# Development install instructions
+
+## Prerequisites
+
+- Install [uv](https://docs.astral.sh/uv/getting-started/installation/).
+- Install [direnv](https://direnv.net/) to automatically load the project virtual environment when entering it.
+    - Mac: `brew install direnv`
+    - Linux: `curl -sfL https://direnv.net/install.sh | bash`
+
+## Setting up the environment
+
+Run the following:
+
+```bash
+# In the root of the project folder
+uv sync # Installs the virtual environment at './.venv'
+direnv allow # Allows the automatic running of the script './.envrc'
+nbl install-hooks # Installs a git hooks that ensures that notebooks are added properly
+```
+
+You are now set up to develop the codebase.
+
+Further instructions:
+
+- To export notebooks run `nbl export`.
+- To clean notebooks run `nbl clean`.
+- To see other available commands run just `nbl`.
+- To add a new dependency run `uv add package-name`. See the the [uv documentation](https://docs.astral.sh/uv/) for more details.
+- You need to `git add` all 'twinned' notebooks for the commit to be validated by the git-hook. For example, if you add `nbs/my-nb.ipynb`, you must also add `pts/my-nb.pct.py`.
+<!-- #endregion -->

boxyard-0.2.0/pyproject.toml

@@ -0,0 +1,101 @@
+[project]
+name = "boxyard"
+version = "0.2.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+    "filelock>=3.12.0",
+    "pydantic>=2.12.4",
+    "python-ulid[pydantic]>=3.1.0",
+    "rich>=14.2.0",
+    "toml>=0.10.2",
+    "typer>=0.20.0",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/boxyard"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/boxyard/**", "LICENSE", "README.md"]
+
+[dependency-groups]
+dev = [
+    "git-cliff>=2.10.1",
+    "ipywidgets>=8.1.8",
+    "jupyterlab>=4.4.0",
+    "nblite>=1.1.10",
+    "pytest>=9.0.0",
+    "python-dotenv>=1.2.1",
+    "ruff>=0.14.13",
+    "twine>=6.2.0",
+]
+
+[project.scripts]
+boxyard = "boxyard._cli.app:app"
+
+[tool.pytest.ini_options]
+testpaths = ["src/tests"]
+python_files = ["test_*.py"]
+python_functions = ["test_*"]
+pythonpath = ["src"]
+markers = [
+    "integration: marks tests as integration tests (require external resources like rclone)",
+    "remote: marks tests that require remote storage credentials (skipped if not configured)",
+]
+
+[tool.ruff]
+target-version = "py311"
+line-length = 120
+exclude = []
+extend-exclude = [
+    "__*.pct.py",
+    "*.ipynb", # ruff does not play nice with nblite
+] 
+
+[tool.ruff.lint]
+select = [
+    "E",      # pycodestyle errors
+    "W",      # pycodestyle warnings
+    "F",      # pyflakes
+    "I",      # isort
+    "B",      # flake8-bugbear
+    "C4",     # flake8-comprehensions
+    "UP",     # pyupgrade
+]
+ignore = [
+    "E501",   # line too long (handled by formatter)
+    "B008",   # do not perform function calls in argument defaults
+    "E402",   # Module level import not at top (module-level-import-not-at-top)
+]
+
+[tool.ruff.lint.per-file-ignores]
+"*.pct.py" = [
+    "I001", # Unsorted imports
+    "E701", # Multiple statements on one line newline (no-multiple-statements)
+    "E702", # Multiple statements on one line semicolon (no-multiple-statements)
+    "E703", # useless-semicolon
+    "E265", # Block comment should start with '# ' (nblite uses #|directive)
+]
+# All src/boxyard/ files are autogenerated from notebooks via nblite.
+# They have patterns that are intentional in notebook-driven development
+# but trigger ruff warnings (unsorted imports, lambda assignments, etc.)
+"src/boxyard/**/*.py" = [
+    "I001", "E731", "B904", "B905", "B018", "B006", "B007", "B020", "B023",
+    "C401", "C408", "C416", "C419",
+    "F401", "F403", "F405", "F541", "F841",
+    "E721",
+    "UP017", "UP024", "UP035", "UP041",
+    "W293",
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["nblite"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"

boxyard-0.2.0/src/boxyard/_cli/__init__.py

@@ -0,0 +1,3 @@
+from . import main
+from .app import app
+from .multi_sync import cli_multi_sync

boxyard-0.2.0/src/boxyard/_cli/app.py

@@ -0,0 +1,10 @@
+# AUTOGENERATED! DO NOT EDIT! File to edit: pts/mod/_cli/app.pct.py
+
+__all__ = ["app", "app_state"]
+
+# %% pts/mod/_cli/app.pct.py 3
+import typer
+
+# %% pts/mod/_cli/app.pct.py 4
+app = typer.Typer(invoke_without_command=True)
+app_state = {}