Metadata-Version: 2.4
Name: mpds
Version: 0.2.0a0
Summary: Motion-Picture DataSet Python Implementation
License-Expression: Apache-2.0
Requires-Python: <3.15,>=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: semver
Requires-Dist: numpy
Requires-Dist: av!=17.0.0,<17,>=16
Requires-Dist: python-mimeparse
Requires-Dist: bidict
Requires-Dist: sortedcontainers
Requires-Dist: typing_extensions; python_version <= "3.10"
Provides-Extra: benchmark
Requires-Dist: prefixed; extra == "benchmark"
Requires-Dist: tqdm; extra == "benchmark"
Provides-Extra: example
Provides-Extra: full
Requires-Dist: mpds[benchmark]; extra == "full"
Requires-Dist: mpds[example]; extra == "full"
Provides-Extra: test
Requires-Dist: pytest>=6; extra == "test"
Requires-Dist: mpds[full]; extra == "test"
Provides-Extra: lint
Requires-Dist: ruff; extra == "lint"
Provides-Extra: doc
Requires-Dist: pillow; extra == "doc"
Requires-Dist: jupyter-book<2,>=1; extra == "doc"
Requires-Dist: sphinxcontrib-mermaid; extra == "doc"
Dynamic: license-file

# mpds-python
Motion-Picture DataSet

## Usage
Audience: general public.

Refer to the documentation published 
[here](https://mpds-python.readthedocs.io)
or the `docs` directory.

## Development
Audience: package developers/contributors.

Directory structure:
- `packages`: Package source code.
- `docs`: Package documentation.

Setup:
- Clone this repository and `cd` into it.
- Run `python3 -m pip install --editable .`.
- (Optional) Test: 
    - Run `python3 -m pip install --editable .[test] pytest`.
    - Run `python3 -m pytest packages/`.
    - For test coverage:
        - Run `python3 -m pip install pytest-cov`.
        - Run `python3 -m pytest packages/ --cov`.
    - For memory profiling:
        - Run `python3 -m pip install pytest-memray`.
        - Run `python3 -m pytest packages/ --memray`.
- (Optional) Build the documentation:
    - Run `python3 -m pip install --editable .[doc] jupyter-book`.
    - Run `jupyter-book build docs/`.
- (Optional) Check/format code:
    - Run `python3 -m pip install --editable .[lint] ruff`
    - Run `python3 -m ruff check packages/`
    - Run `python3 -m ruff format packages/`
