tldm 1.0.0__tar.gz

tldm-1.0.0/.gitattributes

@@ -0,0 +1,11 @@
+[attr]py-file  eol=lf
+*.py           py-file
+
+.git*          export-ignore
+.mailmap       export-ignore
+.meta/         export-ignore
+images/        export-ignore
+benchmarks/    export-ignore
+asv.conf.json  export-ignore
+
+uv.lock linguist-generated=true

tldm-1.0.0/.github/workflows/check.yml

@@ -0,0 +1,17 @@
+name: Check
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+jobs:
+  lint:
+    name: Lint and Type Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - name: Run linting and type checking
+        run: make lint

tldm-1.0.0/.github/workflows/publish.yml

@@ -0,0 +1,20 @@
+# Automatically publishes version of the package on tagged release
+name: publish
+on:
+  push:
+    tags:
+      - "v*.*.*"
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        env:
+          PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+        run: uv publish --token $PYPI_TOKEN

tldm-1.0.0/.github/workflows/test.yml

@@ -0,0 +1,33 @@
+name: Test
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+jobs:
+  test:
+    name: Python ${{ matrix.python-version }} - ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.11", "3.12", "3.13", "3.14"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+      - name: Set up Python ${{ matrix.python-version }}
+        run: uv python install ${{ matrix.python-version }}
+      - name: Run tests with coverage
+        run: make pytest-cov
+      - name: Display coverage report
+        if: always()
+        run: uv run coverage report
+      - name: Upload coverage to Codecov
+        if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.12'
+        uses: codecov/codecov-action@v4
+        with:
+          file: ./coverage.xml
+          token: ${{ secrets.CODECOV_TOKEN }}

tldm-1.0.0/.gitignore

@@ -0,0 +1,26 @@
+*.py[cod]
+*.so
+__pycache__/
+.ipynb_checkpoints/
+
+# Packages
+/tqdm/_dist_ver.py
+/*.egg*/
+/build/
+/dist/
+/snapcraft.yaml
+/tqdm_*.snap
+/.dockerignore
+/Dockerfile
+
+# Unit test / coverage reports
+/.tox/
+/.coverage*
+/coverage.xml
+/.pytest_cache/
+/.asv/
+
+# Sumbodules
+/wiki/
+/docs/
+/feedstock/

tldm-1.0.0/.vscode/settings.json

@@ -0,0 +1,9 @@
+{
+    "editor.formatOnSave": true,
+    "[python]": {
+        "editor.defaultFormatter": "charliermarsh.ruff"
+    },
+    "python-envs.defaultEnvManager": "ms-python.python:venv",
+    "python-envs.defaultPackageManager": "ms-python.python:pip",
+    "python-envs.pythonProjects": []
+}

tldm-1.0.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+caleb@calebevans.me.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

tldm-1.0.0/CONTRIBUTING.md

@@ -0,0 +1,136 @@
+# Contributing to TL;DM
+
+Thank you for your interest in contributing to TL;DM! This guide will help you get started with the development workflow.
+
+## Code of Conduct
+
+When interacting with other users and maintainers, please be sure to abide by the [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Submitting an Issue
+
+### Bug Reports
+
+If you are submitting a bug report, please answer the following questions:
+
+1. What version of TL;DM were you using?
+2. What were you doing?
+3. What did you expect to happen?
+4. What happened instead?
+
+Please provide any code to reproduce the issue, if possible.
+
+### Feature Requests
+
+If you are requesting a new feature or change in behavior, please describe what you are looking for, and what value it will add to your use case.
+
+## Modifying the Codebase
+
+TL;DM is an open-source project, so you are welcome and encouraged to modify the codebase with new fixes and enhancements. Please observe the following guidelines when submitting pull requests:
+
+### Setting Up Your Environment
+
+The dependencies for the project are managed with [uv](https://github.com/astral-sh/uv). For instructions on how to install `uv`, see the [uv documentation](https://docs.astral.sh/uv/getting-started/installation/).
+
+To create a virtual environment and install all project dependencies, run:
+
+```bash
+uv sync
+```
+
+### Code Quality Standards
+
+1. **Code Formatting and Linting**: All code must comply with the enabled ruff lint rules. If you have installed the development dependencies, the `ruff` package will be available with the config in `pyproject.toml`. Run the formatter with:
+
+```bash
+make format
+# or: uv run ruff format src/tldm tests
+```
+
+2. **Type Checking**: All new code must include type annotations and pass type checking with [mypy](https://mypy.readthedocs.io/en/stable/). Run type checking with:
+
+```bash
+make mypy
+# or: uv run mypy src/tldm/std.py src/tldm/utils.py src/tldm/aliases.py
+```
+
+3. **Testing**: Whether you are introducing a bug fix or a new feature, you must add tests to verify that your code additions function correctly. Run tests with:
+
+```bash
+make pytest
+# or: uv run pytest
+```
+
+4. **Code Coverage**: Please ensure your changes are covered by tests. Run tests with coverage:
+
+```bash
+make pytest-cov
+# or: uv run pytest --cov=tldm --cov-report=xml --cov-report=term --cov-report=html
+```
+
+If the coverage report needs detailed review, you can open the HTML coverage report:
+
+```bash
+open htmlcov/index.html  # macOS/Linux
+start htmlcov\index.html  # Windows
+```
+
+5. **Documentation**: If you are adding a new feature or changing behavior, please update the documentation appropriately. This includes updating docstrings for all functions in the public interface, using the [NumPy style](https://numpydoc.readthedocs.io/en/latest/format.html).
+
+### Running All Checks
+
+You can run all formatting, linting, and tests with a single command:
+
+```bash
+make all
+```
+
+This will:
+
+1. Format code with ruff
+2. Run linting checks
+3. Run mypy type checking
+4. Run pytest with coverage
+
+### Available Make Commands
+
+The project includes a Makefile with convenient shortcuts. Run `make help` to see all available commands:
+
+- `make format` - Format code with ruff
+- `make lint` - Run ruff linting and mypy type checking
+- `make mypy` - Run mypy type checking only
+- `make pytest` - Run pytest without coverage
+- `make pytest-cov` - Run pytest with coverage reports
+- `make all` - Run formatting, linting, and tests with coverage
+- `make clean` - Clean up build artifacts and cache files
+
+## Pull Request Workflow
+
+Contributions to the project are made using the "Fork & Pull" model:
+
+1. Fork the [`tldm`](https://github.com/eliotwrobson/tldm) repository
+2. Clone your fork locally: `git clone https://github.com/your_account/tldm.git`
+3. Create a new branch for your changes: `git checkout -b my-feature-branch`
+4. Make your changes on the local copy
+5. Ensure all tests pass and code is formatted: `make all`
+6. Commit your changes: `git commit -m "Description of changes"`
+7. Push to your GitHub fork: `git push origin my-feature-branch`
+8. Create a Pull Request from your GitHub fork (go to your fork's webpage and click "Pull Request")
+
+### Before Submitting a Pull Request
+
+Please ensure:
+
+- All tests pass locally
+- Code is properly formatted (run `make format`)
+- Type checking passes (run `make mypy`)
+- Your changes include appropriate tests
+- Documentation is updated if needed
+
+## Questions or Issues?
+
+If you have questions or run into issues while contributing, feel free to:
+
+- Open an issue on [GitHub](https://github.com/eliotwrobson/tldm/issues)
+- Check existing issues and pull requests for similar discussions
+
+Thank you for contributing to TL;DM!