| Name | joblib JSON |
| Version |
1.5.2
JSON |
| download |
| home_page | None |
| Summary | Lightweight pipelining with Python functions |
| upload_time | 2025-08-27 12:15:46 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | BSD 3-Clause |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
|PyPi| |CIStatus| |ReadTheDocs| |Codecov|
.. |PyPi| image:: https://badge.fury.io/py/joblib.svg
:target: https://badge.fury.io/py/joblib
:alt: Joblib version
.. |CIStatus| image:: https://github.com/joblib/joblib/actions/workflows/test.yml/badge.svg
:target: https://github.com/joblib/joblib/actions/workflows/test.yml?query=branch%3Amain
:alt: CI status
.. |ReadTheDocs| image:: https://readthedocs.org/projects/joblib/badge/?version=latest
:target: https://joblib.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. |Codecov| image:: https://codecov.io/gh/joblib/joblib/branch/main/graph/badge.svg
:target: https://codecov.io/gh/joblib/joblib
:alt: Codecov coverage
The homepage of joblib with user documentation is located on:
https://joblib.readthedocs.io
Getting the latest code
=======================
To get the latest code using git, simply type::
git clone https://github.com/joblib/joblib.git
If you don't have git installed, you can download a zip
of the latest code: https://github.com/joblib/joblib/archive/refs/heads/main.zip
Installing
==========
You can use `pip` to install joblib from any directory::
pip install joblib
or install it in editable mode from the source directory::
pip install -e .
Dependencies
============
- Joblib has no mandatory dependencies besides Python (supported versions are
3.9+).
- Joblib has an optional dependency on Numpy (at least version 1.6.1) for array
manipulation.
- Joblib includes its own vendored copy of
`loky <https://github.com/tomMoral/loky>`_ for process management.
- Joblib can efficiently dump and load numpy arrays but does not require numpy
to be installed.
- Joblib has an optional dependency on
`python-lz4 <https://pypi.python.org/pypi/lz4>`_ as a faster alternative to
zlib and gzip for compressed serialization.
- Joblib has an optional dependency on psutil to mitigate memory leaks in
parallel worker processes.
- Some examples require external dependencies such as pandas. See the
instructions in the `Building the docs`_ section for details.
Workflow to contribute
======================
To contribute to joblib, first create an account on `github
<https://github.com/>`_. Once this is done, fork the `joblib repository
<https://github.com/joblib/joblib>`_ to have your own repository,
clone it using ``git clone``. Make your changes in a branch of your clone, push
them to your github account, test them locally, and when you are happy with
them, send a pull request to the main repository.
You can use `pre-commit <https://pre-commit.com/#install>`_ to run code style checks
before each commit::
pip install pre-commit
pre-commit install
pre-commit checks can be disabled for a single commit with::
git commit -n
Running the test suite
======================
To run the test suite, you need the pytest (version >= 3) and coverage modules.
Run the test suite using::
pytest joblib
from the root of the project.
Building the docs
=================
To build the docs you need to have sphinx (>=1.4) and some dependencies
installed::
pip install -U -r .readthedocs-requirements.txt
The docs can then be built with the following command::
make doc
The html docs are located in the ``doc/_build/html`` directory.
Making a source tarball
=======================
To create a source tarball, eg for packaging or distributing, run the
following command::
pip install build
python -m build --sdist
The tarball will be created in the `dist` directory. This command will create
the resulting tarball that can be installed with no extra dependencies than the
Python standard library.
Making a release and uploading it to PyPI
=========================================
This command is only run by project manager, to make a release, and
upload in to PyPI::
pip install build
python -m build --sdist --wheel
twine upload dist/*
Note that the documentation should automatically get updated at each git
push. If that is not the case, try building th doc locally and resolve
any doc build error (in particular when running the examples).
Updating the changelog
======================
Changes are listed in the CHANGES.rst file. They must be manually updated
but, the following git command may be used to generate the lines::
git log --abbrev-commit --date=short --no-merges --sparse
Raw data
{
"_id": null,
"home_page": null,
"name": "joblib",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Gael Varoquaux <gael.varoquaux@normalesup.org>",
"download_url": "https://files.pythonhosted.org/packages/e8/5d/447af5ea094b9e4c4054f82e223ada074c552335b9b4b2d14bd9b35a67c4/joblib-1.5.2.tar.gz",
"platform": "any",
"description": "|PyPi| |CIStatus| |ReadTheDocs| |Codecov|\n\n.. |PyPi| image:: https://badge.fury.io/py/joblib.svg\n :target: https://badge.fury.io/py/joblib\n :alt: Joblib version\n\n.. |CIStatus| image:: https://github.com/joblib/joblib/actions/workflows/test.yml/badge.svg\n :target: https://github.com/joblib/joblib/actions/workflows/test.yml?query=branch%3Amain\n :alt: CI status\n\n.. |ReadTheDocs| image:: https://readthedocs.org/projects/joblib/badge/?version=latest\n :target: https://joblib.readthedocs.io/en/latest/?badge=latest\n :alt: Documentation Status\n\n.. |Codecov| image:: https://codecov.io/gh/joblib/joblib/branch/main/graph/badge.svg\n :target: https://codecov.io/gh/joblib/joblib\n :alt: Codecov coverage\n\n\nThe homepage of joblib with user documentation is located on:\n\nhttps://joblib.readthedocs.io\n\nGetting the latest code\n=======================\n\nTo get the latest code using git, simply type::\n\n git clone https://github.com/joblib/joblib.git\n\nIf you don't have git installed, you can download a zip\nof the latest code: https://github.com/joblib/joblib/archive/refs/heads/main.zip\n\nInstalling\n==========\n\nYou can use `pip` to install joblib from any directory::\n\n pip install joblib\n\nor install it in editable mode from the source directory::\n\n pip install -e .\n\nDependencies\n============\n\n- Joblib has no mandatory dependencies besides Python (supported versions are\n 3.9+).\n- Joblib has an optional dependency on Numpy (at least version 1.6.1) for array\n manipulation.\n- Joblib includes its own vendored copy of\n `loky <https://github.com/tomMoral/loky>`_ for process management.\n- Joblib can efficiently dump and load numpy arrays but does not require numpy\n to be installed.\n- Joblib has an optional dependency on\n `python-lz4 <https://pypi.python.org/pypi/lz4>`_ as a faster alternative to\n zlib and gzip for compressed serialization.\n- Joblib has an optional dependency on psutil to mitigate memory leaks in\n parallel worker processes.\n- Some examples require external dependencies such as pandas. See the\n instructions in the `Building the docs`_ section for details.\n\nWorkflow to contribute\n======================\n\nTo contribute to joblib, first create an account on `github\n<https://github.com/>`_. Once this is done, fork the `joblib repository\n<https://github.com/joblib/joblib>`_ to have your own repository,\nclone it using ``git clone``. Make your changes in a branch of your clone, push\nthem to your github account, test them locally, and when you are happy with\nthem, send a pull request to the main repository.\n\nYou can use `pre-commit <https://pre-commit.com/#install>`_ to run code style checks\nbefore each commit::\n\n pip install pre-commit\n pre-commit install\n\npre-commit checks can be disabled for a single commit with::\n\n git commit -n\n\nRunning the test suite\n======================\n\nTo run the test suite, you need the pytest (version >= 3) and coverage modules.\nRun the test suite using::\n\n pytest joblib\n\nfrom the root of the project.\n\nBuilding the docs\n=================\n\nTo build the docs you need to have sphinx (>=1.4) and some dependencies\ninstalled::\n\n pip install -U -r .readthedocs-requirements.txt\n\nThe docs can then be built with the following command::\n\n make doc\n\nThe html docs are located in the ``doc/_build/html`` directory.\n\n\nMaking a source tarball\n=======================\n\nTo create a source tarball, eg for packaging or distributing, run the\nfollowing command::\n\n pip install build\n python -m build --sdist\n\nThe tarball will be created in the `dist` directory. This command will create\nthe resulting tarball that can be installed with no extra dependencies than the\nPython standard library.\n\nMaking a release and uploading it to PyPI\n=========================================\n\nThis command is only run by project manager, to make a release, and\nupload in to PyPI::\n\n pip install build\n python -m build --sdist --wheel\n twine upload dist/*\n\n\nNote that the documentation should automatically get updated at each git\npush. If that is not the case, try building th doc locally and resolve\nany doc build error (in particular when running the examples).\n\nUpdating the changelog\n======================\n\nChanges are listed in the CHANGES.rst file. They must be manually updated\nbut, the following git command may be used to generate the lines::\n\n git log --abbrev-commit --date=short --no-merges --sparse\n",
"bugtrack_url": null,
"license": "BSD 3-Clause",
"summary": "Lightweight pipelining with Python functions",
"version": "1.5.2",
"project_urls": {
"Homepage": "https://joblib.readthedocs.io",
"Source": "https://github.com/joblib/joblib"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "1ee8685f47e0d754320684db4425a0967f7d3fa70126bffd76110b7009a0090f",
"md5": "23dbf286d71aed98ca2f1d90f21bbb8a",
"sha256": "4e1f0bdbb987e6d843c70cf43714cb276623def372df3c22fe5266b2670bc241"
},
"downloads": -1,
"filename": "joblib-1.5.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "23dbf286d71aed98ca2f1d90f21bbb8a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 308396,
"upload_time": "2025-08-27T12:15:45",
"upload_time_iso_8601": "2025-08-27T12:15:45.188972Z",
"url": "https://files.pythonhosted.org/packages/1e/e8/685f47e0d754320684db4425a0967f7d3fa70126bffd76110b7009a0090f/joblib-1.5.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e85d447af5ea094b9e4c4054f82e223ada074c552335b9b4b2d14bd9b35a67c4",
"md5": "560040af32080ce8c4b092a2cd320e26",
"sha256": "3faa5c39054b2f03ca547da9b2f52fde67c06240c31853f306aea97f13647b55"
},
"downloads": -1,
"filename": "joblib-1.5.2.tar.gz",
"has_sig": false,
"md5_digest": "560040af32080ce8c4b092a2cd320e26",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 331077,
"upload_time": "2025-08-27T12:15:46",
"upload_time_iso_8601": "2025-08-27T12:15:46.575846Z",
"url": "https://files.pythonhosted.org/packages/e8/5d/447af5ea094b9e4c4054f82e223ada074c552335b9b4b2d14bd9b35a67c4/joblib-1.5.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-08-27 12:15:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "joblib",
"github_project": "joblib",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "joblib"
}
