Metadata-Version: 2.1
Name: kttools
Version: 0.2.1
Summary: Kelvin's miscellaneous tools for python
License: MIT
Author: Zewen Kelvin Tuong
Author-email: z.tuong@uq.edu.au
Requires-Python: >=3.8
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3
Provides-Extra: docs
Requires-Dist: anndata (>=0.7.6)
Requires-Dist: matplotlib (>=3.5.2)
Requires-Dist: numpy (>=1.21.6)
Requires-Dist: pandas (>=1.2.4)
Requires-Dist: readthedocs-sphinx-ext ; extra == "docs"
Requires-Dist: recommonmark ; extra == "docs"
Requires-Dist: scanpy (>=1.7.1)
Requires-Dist: sphinx-autodoc-typehints ; extra == "docs"
Requires-Dist: sphinx_rtd_theme ; extra == "docs"
Description-Content-Type: text/x-rst

|Docs| |PyPI|

kttools
=======

Kelvin’s miscellaneous python tools

Install
~~~~~~~

.. code:: bash

   pip install kttools

   # or 
   pip install git+https://github.com/zktuong/kttools.git

   # or
   git clone https://github.com/zktuong/kttools.git
   cd kttools; pip install -e .

Usage
~~~~~

.. code:: python

   import tools 

Please checkout the documentation
`api <https://kttools.readthedocs.org>`__ for details about the
functions you can use to make your life easier.

jupyterhub issue
~~~~~~~~~~~~~~~~

On jupyterhub, If you find yourself trying to import from local
directory, i.e. ``git clone``, and finding that you can’t import it, you
will need to edit your your ``kernel.json`` file like so:

.. code:: bash

   vi /home/jovyan/.local/share/jupyter/kernels/<condaenvironmentname>/kernel.json 

add in the ``$PATH`` and ``$PYTHONPATH`` bits:

.. code:: bash

   {
    "argv": [
     "/home/jovyan/my-conda-envs/<condaenvironmentname>/bin/python",
     "-m",
     "ipykernel_launcher",
     "-f",
     "{connection_file}"
    ],
    "env": {
        "PATH": "/home/jovyan/scripts/kttools:$PATH",
        "PYTHONPATH": "/home/jovyan/scripts/kttools:$PYTHONPATH"
    },
    "display_name": "Python (<condaenvironmentname>)",
    "language": "python"
   }

.. |Docs| image:: https://readthedocs.org/projects/kttools/badge/?version=latest
   :target: https://kttools.readthedocs.io/en/latest/?badge=latest
.. |PyPI| image:: https://img.shields.io/pypi/v/kttools?logo=PyPI
   :target: https://pypi.org/project/kttools/

