cit-course-tools 0.1.0__tar.gz

cit_course_tools-0.1.0/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## 0.1.0
+
+- Add interactive, scaffold-only, report-only, and combined CLI modes.
+- Accept an explicit workspace target, defaulting to the current directory.
+- Create idempotent workspace guidance without overwriting student content.
+- Generate a cross-platform, privacy-conscious hardware report.
+- Add the `cit-course` console command and `cit-course-tools` PyPI metadata.

cit_course_tools-0.1.0/MANIFEST.in

@@ -0,0 +1,20 @@
+include cit_setup.py
+include PYPI_README.md
+include PUBLISHING.md
+include CHANGELOG.md
+include pyproject.toml
+recursive-include tests *.py
+
+exclude README.md
+exclude ai_hardware_check.py
+exclude lab3_prompting_structured_output.py
+exclude *.docx
+exclude *.pdf
+exclude *.xlsx
+prune labs
+prune llama.cpp
+prune models
+prune project
+prune specs
+global-exclude __pycache__
+global-exclude *.py[cod]

cit_course_tools-0.1.0/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.4
+Name: cit-course-tools
+Version: 0.1.0
+Summary: Course workspace and hardware-report tools for CIT classes
+Keywords: CIT,course tools,education,llama.cpp,local AI,workspace
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Education
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Education
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# CIT Course Tools
+
+`cit-course-tools` is a small, cross-platform collection of command-line tools
+for Computer Information Technology courses. The initial release creates the
+recommended CIT 495 workspace and, when requested, generates a privacy-conscious
+hardware report for local-AI and llama.cpp troubleshooting.
+
+The utility does **not** download or install llama.cpp, AI models, or any other
+external software. It has no third-party runtime dependencies.
+
+## Installation
+
+For an isolated command-line installation, use [`pipx`](https://pipx.pypa.io/):
+
+```console
+pipx install cit-course-tools
+```
+
+It can also be installed into an existing Python environment:
+
+```console
+python -m pip install cit-course-tools
+```
+
+Python 3.10 or newer is required.
+
+## Usage
+
+Navigate to the intended course workspace and use `.`:
+
+```console
+cd /path/to/CIT495
+cit-course .
+```
+
+Or supply the workspace directory directly:
+
+```console
+cit-course --all /path/to/CIT495
+```
+
+On Windows, a path containing spaces should be quoted:
+
+```powershell
+cit-course --all "C:\Users\Student\Courses\CIT495"
+```
+
+Available operations are:
+
+```console
+cit-course . --scaffold
+cit-course . --specs
+cit-course . --all
+cit-course --help
+```
+
+With no operation flag, the utility runs interactively. If the target is
+omitted, it defaults to the current directory.
+
+The utility stays in its installed Python environment. It is never copied or
+moved into the course workspace.
+
+## Workspace structure
+
+The initial scaffold is:
+
+```text
+CIT495/
+├── README.md
+├── models/
+│   └── README.md
+├── llama.cpp/
+│   └── README.md
+├── labs/
+│   ├── README.md
+│   └── lab01/
+│       ├── logs/
+│       ├── prompts/
+│       └── results/
+├── project/
+│   └── README.md
+└── specs/
+    └── README.md
+```
+
+Later lab directories are added as the semester progresses. The persistent
+semester system belongs in `project/`, while lab evidence belongs under
+`labs/`.
+
+Scaffolding is idempotent: missing components are restored, populated README
+files are preserved, and student files are not deleted.
+
+## Hardware report and privacy
+
+The optional report is written to:
+
+```text
+<workspace>/specs/hardware_specs.txt
+```
+
+It may include the operating system, architecture, CPU, CPU counts, memory,
+storage, relevant instruction sets, Python version, and detected GPUs. Some
+details may be unavailable on a particular system.
+
+The report intentionally excludes usernames, serial numbers, device IDs, MAC
+and IP addresses, license keys, credentials, precise location, and unrelated
+software inventories. Students should still review the report before sharing
+it.
+
+## Development
+
+Run the standard-library test suite with:
+
+```console
+python -m unittest discover -s tests -v
+```
+
+See `PUBLISHING.md` for the release checklist.

cit_course_tools-0.1.0/PUBLISHING.md

@@ -0,0 +1,43 @@
+# Publishing `cit-course-tools`
+
+## Before the first public release
+
+1. Choose and add the intended software license. Licensing is deliberately not
+   inferred by the package scaffold.
+2. Add author or maintainer metadata and project URLs to `pyproject.toml` if
+   desired.
+3. Confirm that `cit-course-tools` is still available on PyPI. Name availability is
+   final only when the first project release is created.
+4. Run the test suite on Windows, macOS, and Linux.
+
+## Build and inspect
+
+Install release tooling in an isolated development environment:
+
+```console
+python -m pip install --upgrade build twine
+```
+
+Then test and build:
+
+```console
+python -m unittest discover -s tests -v
+python -m build
+python -m twine check dist/*
+```
+
+Inspect both archives before uploading. They must not contain course documents,
+student files, generated workspaces, hardware reports, or credentials.
+
+## TestPyPI
+
+Upload the first candidate to TestPyPI and install it in a clean environment
+before making a public release:
+
+```console
+python -m twine upload --repository testpypi dist/*
+```
+
+TestPyPI and PyPI use separate accounts. For ongoing releases, configure PyPI
+Trusted Publishing through the source repository's CI provider instead of
+storing a long-lived API token.

cit_course_tools-0.1.0/PYPI_README.md

@@ -0,0 +1,118 @@
+# CIT Course Tools
+
+`cit-course-tools` is a small, cross-platform collection of command-line tools
+for Computer Information Technology courses. The initial release creates the
+recommended CIT 495 workspace and, when requested, generates a privacy-conscious
+hardware report for local-AI and llama.cpp troubleshooting.
+
+The utility does **not** download or install llama.cpp, AI models, or any other
+external software. It has no third-party runtime dependencies.
+
+## Installation
+
+For an isolated command-line installation, use [`pipx`](https://pipx.pypa.io/):
+
+```console
+pipx install cit-course-tools
+```
+
+It can also be installed into an existing Python environment:
+
+```console
+python -m pip install cit-course-tools
+```
+
+Python 3.10 or newer is required.
+
+## Usage
+
+Navigate to the intended course workspace and use `.`:
+
+```console
+cd /path/to/CIT495
+cit-course .
+```
+
+Or supply the workspace directory directly:
+
+```console
+cit-course --all /path/to/CIT495
+```
+
+On Windows, a path containing spaces should be quoted:
+
+```powershell
+cit-course --all "C:\Users\Student\Courses\CIT495"
+```
+
+Available operations are:
+
+```console
+cit-course . --scaffold
+cit-course . --specs
+cit-course . --all
+cit-course --help
+```
+
+With no operation flag, the utility runs interactively. If the target is
+omitted, it defaults to the current directory.
+
+The utility stays in its installed Python environment. It is never copied or
+moved into the course workspace.
+
+## Workspace structure
+
+The initial scaffold is:
+
+```text
+CIT495/
+├── README.md
+├── models/
+│   └── README.md
+├── llama.cpp/
+│   └── README.md
+├── labs/
+│   ├── README.md
+│   └── lab01/
+│       ├── logs/
+│       ├── prompts/
+│       └── results/
+├── project/
+│   └── README.md
+└── specs/
+    └── README.md
+```
+
+Later lab directories are added as the semester progresses. The persistent
+semester system belongs in `project/`, while lab evidence belongs under
+`labs/`.
+
+Scaffolding is idempotent: missing components are restored, populated README
+files are preserved, and student files are not deleted.
+
+## Hardware report and privacy
+
+The optional report is written to:
+
+```text
+<workspace>/specs/hardware_specs.txt
+```
+
+It may include the operating system, architecture, CPU, CPU counts, memory,
+storage, relevant instruction sets, Python version, and detected GPUs. Some
+details may be unavailable on a particular system.
+
+The report intentionally excludes usernames, serial numbers, device IDs, MAC
+and IP addresses, license keys, credentials, precise location, and unrelated
+software inventories. Students should still review the report before sharing
+it.
+
+## Development
+
+Run the standard-library test suite with:
+
+```console
+python -m unittest discover -s tests -v
+```
+
+See `PUBLISHING.md` for the release checklist.

cit_course_tools-0.1.0/cit_course_tools.egg-info/PKG-INFO

@@ -0,0 +1,140 @@
+Metadata-Version: 2.4
+Name: cit-course-tools
+Version: 0.1.0
+Summary: Course workspace and hardware-report tools for CIT classes
+Keywords: CIT,course tools,education,llama.cpp,local AI,workspace
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Education
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Education
+Classifier: Topic :: System :: Systems Administration
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# CIT Course Tools
+
+`cit-course-tools` is a small, cross-platform collection of command-line tools
+for Computer Information Technology courses. The initial release creates the
+recommended CIT 495 workspace and, when requested, generates a privacy-conscious
+hardware report for local-AI and llama.cpp troubleshooting.
+
+The utility does **not** download or install llama.cpp, AI models, or any other
+external software. It has no third-party runtime dependencies.
+
+## Installation
+
+For an isolated command-line installation, use [`pipx`](https://pipx.pypa.io/):
+
+```console
+pipx install cit-course-tools
+```
+
+It can also be installed into an existing Python environment:
+
+```console
+python -m pip install cit-course-tools
+```
+
+Python 3.10 or newer is required.
+
+## Usage
+
+Navigate to the intended course workspace and use `.`:
+
+```console
+cd /path/to/CIT495
+cit-course .
+```
+
+Or supply the workspace directory directly:
+
+```console
+cit-course --all /path/to/CIT495
+```
+
+On Windows, a path containing spaces should be quoted:
+
+```powershell
+cit-course --all "C:\Users\Student\Courses\CIT495"
+```
+
+Available operations are:
+
+```console
+cit-course . --scaffold
+cit-course . --specs
+cit-course . --all
+cit-course --help
+```
+
+With no operation flag, the utility runs interactively. If the target is
+omitted, it defaults to the current directory.
+
+The utility stays in its installed Python environment. It is never copied or
+moved into the course workspace.
+
+## Workspace structure
+
+The initial scaffold is:
+
+```text
+CIT495/
+├── README.md
+├── models/
+│   └── README.md
+├── llama.cpp/
+│   └── README.md
+├── labs/
+│   ├── README.md
+│   └── lab01/
+│       ├── logs/
+│       ├── prompts/
+│       └── results/
+├── project/
+│   └── README.md
+└── specs/
+    └── README.md
+```
+
+Later lab directories are added as the semester progresses. The persistent
+semester system belongs in `project/`, while lab evidence belongs under
+`labs/`.
+
+Scaffolding is idempotent: missing components are restored, populated README
+files are preserved, and student files are not deleted.
+
+## Hardware report and privacy
+
+The optional report is written to:
+
+```text
+<workspace>/specs/hardware_specs.txt
+```
+
+It may include the operating system, architecture, CPU, CPU counts, memory,
+storage, relevant instruction sets, Python version, and detected GPUs. Some
+details may be unavailable on a particular system.
+
+The report intentionally excludes usernames, serial numbers, device IDs, MAC
+and IP addresses, license keys, credentials, precise location, and unrelated
+software inventories. Students should still review the report before sharing
+it.
+
+## Development
+
+Run the standard-library test suite with:
+
+```console
+python -m unittest discover -s tests -v
+```
+
+See `PUBLISHING.md` for the release checklist.

cit_course_tools-0.1.0/cit_course_tools.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+CHANGELOG.md
+MANIFEST.in
+PUBLISHING.md
+PYPI_README.md
+cit_setup.py
+pyproject.toml
+cit_course_tools.egg-info/PKG-INFO
+cit_course_tools.egg-info/SOURCES.txt
+cit_course_tools.egg-info/dependency_links.txt
+cit_course_tools.egg-info/entry_points.txt
+cit_course_tools.egg-info/top_level.txt
+tests/test_cit_setup.py

cit_course_tools-0.1.0/cit_course_tools.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

cit_course_tools-0.1.0/cit_course_tools.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+cit-course = cit_setup:cli

cit_course_tools-0.1.0/cit_course_tools.egg-info/top_level.txt

@@ -0,0 +1 @@
+cit_setup