Skip to content

Package Remember's symbolic kernel as a distributable module #3

@blackboxprogramming

Description

@blackboxprogramming

Description

Currently, the Remember project exposes its symbolic kernel as a single Python file without any packaging or installation instructions. This makes it difficult to reuse the functions in other projects. We should package the symbolic kernel as a proper Python module that can be installed via pip.

Proposed work

  • Restructure the repository to include a package directory (e.g., remember/ or symbolic_kernel/) containing __init__.py and the existing symbolic_kernel.py file. Expose relevant functions in __init__.py for convenient imports.
  • Create a setup.py or pyproject.toml with package metadata (name, version, description, author, license) and specify required dependencies.
  • Add a requirements.txt file if there are external dependencies and ensure they are pinned to compatible versions.
  • Update the README with instructions on installing the package locally (e.g., pip install -e .) and a brief usage example.
  • Optionally set up a build script or GitHub Action to build a source distribution and wheel (publishing to PyPI can be considered later but is not required for this task).

Acceptance criteria

  • Developers can install the symbolic kernel module locally using pip install -e . and import its functions (from remember import valence, etc.).
  • Package metadata is complete and passes basic packaging checks (python -m pip install . works without errors).
  • The repository contains a clear README describing installation and usage.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions