Metadata-Version: 2.1
Name: pkgcraft
Version: 0.0.2
Summary: python bindings for pkgcraft
Author-email: radhermit@gmail.com
License: MIT
Project-URL: homepage, https://github.com/pkgcraft/pkgcraft-python
Keywords: gentoo,cython
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
Provides-Extra: test
Requires-Dist: pytest ; extra == 'test'

|CI| |coverage| |pypi|

===============
pkgcraft-python
===============

Python bindings for pkgcraft_.

Install
=======

Install pre-built package from pypi::

    pip install pkgcraft

Install from git (assumes pkgcraft-c has been installed from git and cython is
available)::

    pip install https://github.com/pkgcraft/pkgcraft-python/archive/master.tar.gz

Install from a tarball (assumes required release of pkgcraft-c is installed)::

    python setup.py install

Development
===========

Requirements: >=python-3.9, tox_, valgrind_, and everything required to build
pkgcraft-c_

Use the following commands to set up a dev environment:

.. code-block:: bash

    # clone the pkgcraft workspace and pull the latest project updates
    git clone --recurse-submodules https://github.com/pkgcraft/pkgcraft-workspace.git
    cd pkgcraft-workspace
    git submodule update --recursive --remote

    # build pkgcraft-c library and set shell variables (e.g. $PKG_CONFIG_PATH)
    source ./build pkgcraft-c

    cd pkgcraft-python
    # build and test
    tox -e python

For development purposes, testing is performed under tox using varying targets
for different functions. Use **tox list** to see all the target descriptions.

.. _tox: https://pypi.org/project/tox/
.. _valgrind: https://valgrind.org/
.. _pkgcraft: https://github.com/pkgcraft/pkgcraft
.. _pkgcraft-c: https://github.com/pkgcraft/pkgcraft-c

.. |CI| image:: https://github.com/pkgcraft/pkgcraft-python/workflows/CI/badge.svg
   :target: https://github.com/pkgcraft/pkgcraft-python/actions/workflows/ci.yml
.. |coverage| image:: https://codecov.io/gh/pkgcraft/pkgcraft-python/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/pkgcraft/pkgcraft-python
.. |pypi| image:: https://img.shields.io/pypi/v/pkgcraft.svg
   :target: https://pypi.python.org/pypi/pkgcraft
