Clone the repository with git clone https://github.com/yushiyangk/parsetypes.git.
The source for the package is src/, with tests in tests/.
Create the venv using python -m venv ..
To activate the venv, on Linux run source Scripts/activate, and on Windows run Scripts/Activate.ps1 or Scripts/activate.bat.
Later, to deactivate the venv, run deactivate.
Run pip install -r requirements.dev.txt.
To install the package locally (in the venv) for development, run pip install -e ..
For unit tests, run pytest.
To run unit tests across all supported Python versions, run tox p -m testall. This is slower than just pytest. Note that only Python versions that are installed locally will be run.
To run the full set of tasks before package publication, run tox p -m prepare. Alternatively, see below for manually running individual steps in this process.
Run pytest or coverage run -m pytest.
For coverage report, first run coverage run -m pytest, then either coverage report -m to print to stdout or coverage html to generate an HTML report in htmlcov/. Alternatively, run tox r -m test to do both steps automatically (slower).
Run tox r -m docs.
The documentation is generated in docs/html/, using template files in docs/template/.
Before packaging, check the package metadata by running pyroma . or tox r -m metadata.
To generate sdist and wheel packages, delete dist/ and parsetypes.egg-info/ if they exist, then run python -m build. Run twine check dist/* to check that the packages were generated properly. Alternatively, run tox r -m package to do these steps automatically.
MANIFEST.inAdditional files to include in published sdist packagepyproject.tomlPackage metadata, as well as configs for test and build toolsrequirements.dev.txtPackage dependencies for development, in pip formatrequirements.publish.txtPackage dependencies for publishing, in pip formattox.iniConfig file for tox