https://github.com/joeriddles/py-marktest
py-marktest helps you test Python code samples in your markdown files
https://github.com/joeriddles/py-marktest
Last synced: over 1 year ago
JSON representation
py-marktest helps you test Python code samples in your markdown files
- Host: GitHub
- URL: https://github.com/joeriddles/py-marktest
- Owner: joeriddles
- License: mit
- Created: 2023-12-18T15:54:37.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-12-19T19:35:38.000Z (over 2 years ago)
- Last Synced: 2025-03-26T02:45:46.072Z (over 1 year ago)
- Language: Python
- Size: 21.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# py-marktest
### 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/*
```