Skip to content

BUILD.md

Latest commit

 

History

History
74 lines (48 loc) · 1.05 KB

BUILD.md

File metadata and controls

74 lines (48 loc) · 1.05 KB

Build Instructions

Prerequisites

  • Python 3.10 or later
  • pip

Setup

Install the runtime and build dependencies:

pip install -e .

For development (linting, type-checking, testing), also install the dev extras:

pip install -e . --group dev

For builds and deploys , also install the build extras:

pip install -e . --group build

Running Tests

pytest

With coverage:

pytest --cov=instaparser

Linting & Type Checking

ruff check instaparser/
ruff format --check instaparser/
mypy instaparser/

Building the Package

Build both the sdist and wheel:

python -m build

The outputs will be in the dist/ directory.

Publishing to PyPI

Upload the built artifacts with twine:

twine upload dist/*

To test against Test PyPI first:

twine upload --repository testpypi dist/*

Versioning

The package version is defined in instaparser/__init__.py and read automatically by Hatch at build time via the [tool.hatch.version] configuration in pyproject.toml.