Skip to content

pydiverse/pydiverse.common

Repository files navigation

pydiverse.common

CI Docs pypi-version conda-forge

A base package for different libraries in the pydiverse library collection. This includes functionality like a type-system for tabular data (SQL and DataFrame). This type-system is used for ensuring reliable operation of the pydiverse library with various execution backends like Pandas, Polars, and various SQL dialects.

Installation

To install pydiverse common try this:

git clone https://github.com/pydiverse/pydiverse.common.git
cd pydiverse.common

# Create the environment, activate it and install the pre-commit hooks
pixi install
pixi run pre-commit install

Testing

Tests can be run with:

pixi run pytest

Packaging and publishing to pypi and conda-forge using github actions

  • bump version number in pyproject.toml
  • set correct release date in changelog.md
  • push increased version number to main branch
  • tag commit with git tag <version>, e.g. git tag 0.7.0
  • git push --tags

The package should appear on https://pypi.org/project/pydiverse-common/ in a timely manner. It is normal that it takes a few hours until the new package version is available on https://conda-forge.org/packages/.

Packaging and publishing to Pypi manually

Packages are first released on test.pypi.org:

Finally, they are published via:

  • git tag <version>
  • git push --tags
  • Attention: Please, only continue here, if automatic publishing fails for some reason!
  • pixi run -e release hatch build
  • pixi run -e release twine upload --repository pypi dist/*

Publishing package on conda-forge manually

Conda-forge packages are updated via:

About

Common functionality shared between pydiverse libraries

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •  

Languages