pylenza 0.1.0

A beginner-friendly Python package for learning data structures, algorithms, recursion, and logic.

PyLenza

PyLenza is a beginner-friendly Python package for learning data structures, algorithms, recursion, and logical reasoning. It provides clean, well-documented teaching helpers and small, self-contained algorithms suitable for learners and interview prep.

Quick highlights

• Lightweight, readable implementations for common data structures (arrays, linked lists, stacks, queues, trees).
• Algorithm templates for search & sort plus algorithmic patterns and puzzles (N-Queens, Tower of Hanoi, Kadane, etc.).
• Helpers for recursion, string manipulation, numeric operations and small utilities for learning.

Installation

The package is ready to publish; for local development you can install in editable mode:

python -m pip install -e .

If published on PyPI, users will be able to install with:

pip install pylenza

Usage (copy-paste friendly)

from pylenza import PyArray

arr = PyArray([1, 2, 3, 4])
arr.append(5)
print(arr.mean())  # prints the mean

Modules (overview)

• arrays — PyArray: list-like API + numeric, transform, search & sort helpers
• linkedlist — Singly LinkedList with traversal, mutators and utilities
• queue / stack — Teaching-friendly FIFO / LIFO containers with helpers
• search / sort — Classic search and sorting implementations for learning
• strings — String helpers (palindromes, parsing, substring utilities)
• recursion / trees — Recursion exercises and BinaryTree / BST utilities
• logic — patterns, puzzles, reasoning for algorithmic thinking

Examples & how to run

• Examples are available in the examples/ folder. Each script is standalone and runnable:

  • python examples/array_examples.py
  • python examples/logic_examples.py
  • python examples/recursion_examples.py

  Publishing to PyPI

  There are two common ways to publish releases:

  1. Manual local publish (useful for quick releases):

     1. Create an API token on PyPI (Account → API tokens) and copy it.
     2. Either create a local ~/.pypirc following .pypirc.example (username token, password = token), or pass credentials directly to twine.
     3. Build and upload:

   python -m pip install --upgrade build twine
   python -m build  # produces dist/ wheel and sdist
   python -m twine upload dist/* --username __token__ --password ${PYPI_TOKEN}
  

  2. Automated CI publishing (recommended):

     • A GitHub Actions workflow is included at .github/workflows/publish.yml. It will:

       • run on pushed git tags that start with v (for example v0.1.0)
       • build wheel and sdist, then publish to PyPI via twine.

     • To enable it create a repository secret named PYPI_API_TOKEN with the token value (generated at https://pypi.org/manage/account/ ). Then push a tag:

   git tag v0.1.0
   git push origin v0.1.0
  

  Security note

  • Do NOT store PyPI tokens or credentials in source control. Use GitHub repository secrets for CI or ~/.pypirc locally.

License

This project is distributed under the MIT License.

Contributing

• Pull requests and issues are welcome — keep contributions small and well-documented so they are easy to review.

Contact

• Author: Vedant Shukla [e-mail]