openproficiency 0.0.1

A simple library for managing proficiency topics and topic lists

OpenProficiency - Python Library

This library provides class objects for managing proficiency across knowledge domains.

Features

• Topic Class: A defined unique area of knowledge composed of subtopics and built upon pretopics (prerequisite topics).
• TopicList Class: A collection of related topics covering one knowledge domain.

Installation

pip install openproficiency

Quick Start

Create a Topic

A Topic is an area of knowledge that a person gains proficiency in. If it has subtopics, the person can alternately gain proficiency in the parent topic by gaining proficiency in the subtopics.

from openproficiency import Topic

# Create a simple topic and what composes it
topic_arithmetic = Topic(
    id="arithmetic",
    description="Basic operations for numeric calculations",
    subtopics=["addition", "subtraction"]
    pretopics=['writing']
)

Add a subtopic to an existing topic

# Specific other topics that compose the parent topic
topic_arithmetic.add_subtopic("multiplication")
topic_arithmetic.add_subtopic("division")

Add a pretopic to an existing topic

A Pretopic (prerequisite topic) is a topic that must be understood before a person can begin understanding the parent topic.

# Specify prerequisites to understand first
topic_arithmetic.add_pretopic("integers")
topic_arithmetic.add_pretopic("decimals")
topic_arithmetic.add_pretopic("fractions")

Create a Topic List

A topic list is a collection of topics that describe a specific knowledge domain.

from openproficiency import Topic, TopicList

# Create an empty topic list
topic_list = TopicList(
    owner="core-fundamentals",
    name="math",
    description="Math topics through basic calculus"
)

# Add topics to the list
t_arithmetic = Topic(
    id="arithmetic",
    description="Basic operations for numeric calculations",
    subtopics=[
        "addition",
        "subtraction",
        "multiplication",
        "division
    ]
)
topic_list.add_topic(t_arithmetic)

t_algebra = Topic(
    id="algebra",
    description="Basic operations for numeric calculations",
    subtopics=[
        "variables",
        "constants",
        "single-variable-equations",
        "multiple-variable-equations"
    ],
    pretopics=[ "arithmetic" ]
)

How to Develop

This project is open to pull requests.

Please see the contribution guide to get started.