Metadata-Version: 2.1
Name: py-marktest
Version: 0.0.3
Summary: A command line tool for testing Python snippets in markdown.
Author-email: Joseph Riddle <joeriddles10@gmail.com>
Project-URL: Homepage, https://github.com/joeriddles/py-marktest
Project-URL: Bug Tracker, https://github.com/joeriddles/py-marktest/issues
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Software Development :: Testing :: Unit
Classifier: Topic :: Text Processing :: Markup :: Markdown
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer[all] ==0.9.0
Provides-Extra: dev
Requires-Dist: pytest >=7 ; extra == 'dev'
Requires-Dist: pytest-cov >=4 ; extra == 'dev'

# py-marktest

<p style="align: center">
    <a href="https://pypi.org/project/py-marktest" target="_blank">
        <img src="https://img.shields.io/pypi/v/py-marktest?label=PyPI" alt="Package version" />
    </a>
</p

# <!-- this reset markdown mode somehow -->

### What is py-marktest and why you need it

py-marktest helps you test Python code samples in your markdown files. These code samples can include REPL snippets and code blocks.

---

### Local development

Bootstrap your local environment. This will create a new virtual environment in `./.venv` and install the dev dependencies from `pyproject.toml`.
```shell
make setup
```

Run all tests and report test coverage.
```shell
make test cov
```

---

### Build

Note: these comands assume a valid [`~/.pypirc`](https://packaging.python.org/en/latest/specifications/pypirc/) file is configured.

See the [official packaging docs](https://packaging.python.org/en/latest/tutorials/packaging-projects/) for more info.

```shell
python3 -m pip install --upgrade build twine
python3 -m build
```

Upload to [test.pypi.org](https://test.pypi.org)

```shell
python3 -m twine upload --repository testpypi dist/*
```

Upload to [PyPI](https://pypi.org)

```shell
python3 -m twine upload dist/*
```
