feat: setup dev environment, add topics and topic lists#1
Merged
chriswblake merged 14 commits intomainfrom Jan 29, 2026
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces the initial implementation of the OpenProficiency Python library, along with its development, testing, and packaging infrastructure. The changes establish the core data model for managing topics and topic lists, set up development container and CI workflows, and provide documentation for usage and contribution.
Core Library Implementation:
Topicclass inopenproficiency/Topic.py, representing a knowledge area with support for subtopics and pretopics, including methods to add and manage them.TopicListclass inopenproficiency/TopicList.py, representing a collection of topics, with methods for adding topics, serialization/deserialization to/from JSON, and recursive handling of subtopics and pretopics.openproficiency/__init__.pyto exposeTopicandTopicListfor import.Development and Testing Infrastructure:
.devcontainerconfiguration (.devcontainer/devcontainer.jsonand.devcontainer/postCreate.sh) for consistent local and Codespaces development environments, including Python 3.10, Docker, GitHub CLI, and VS Code extensions. [1] [2].github/workflows/unit-tests.yml) to run unit tests with pytest across Python 3.10–3.14 on pull requests..vscode/settings.json) for Python type checking and test discovery.Packaging and Distribution:
pyproject.toml,setup.py, andMANIFEST.into enable building and publishing the package to PyPI, specifying metadata, dependencies, and included files. [1] [2] [3]requirements-dev.txtfor development and testing dependencies.Documentation:
README.mdwith installation instructions, usage examples forTopicandTopicList, and development guidelines.CONTRIBUTE.mdguide detailing contribution steps, running tests locally, and publishing to PyPI.