# GrimoireLab Toolkit [](https://github.com/chaoss/grimoirelab-toolkit/actions?query=workflow:tests+branch:master+event:push) [](https://coveralls.io/r/chaoss/grimoirelab-toolkit?branch=master)
Toolkit of common functions used across GrimoireLab projects.
This package provides a library composed by functions widely used in other
GrimoireLab projects. These function deal with date handling, introspection,
URIs/URLs, among other topics.
## Requirements
* Python >= 3.8
You will also need some other libraries for running the tool, you can find the
whole list of dependencies in [pyproject.toml](pyproject.toml) file.
## Installation
There are several ways to install GrimoireLab Toolkit on your system: packages or source
code using Poetry or pip.
### PyPI
GrimoireLab Toolkit can be installed using pip, a tool for installing Python packages.
To do it, run the next command:
```
$ pip install grimoirelab-toolkit
```
### Source code
To install from the source code you will need to clone the repository first:
```
$ git clone https://github.com/chaoss/grimoirelab-toolkit
$ cd grimoirelab-toolkit
```
Then use pip or Poetry to install the package along with its dependencies.
#### Pip
To install the package from local directory run the following command:
```
$ pip install .
```
In case you are a developer, you should install GrimoireLab Toolkit in editable mode:
```
$ pip install -e .
```
#### Poetry
We use [poetry](https://python-poetry.org/) for dependency management and
packaging. You can install it following its [documentation](https://python-poetry.org/docs/#installation).
Once you have installed it, you can install GrimoireLab Toolkit and the dependencies in
a project isolated environment using:
```
$ poetry install
```
To spaw a new shell within the virtual environment use:
```
$ poetry shell
```
## License
Licensed under GNU General Public License (GPL), version 3 or later.
Raw data
{
"_id": null,
"home_page": "https://chaoss.github.io/grimoirelab/",
"name": "grimoirelab-toolkit",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.8",
"maintainer_email": null,
"keywords": "development, grimoirelab",
"author": "GrimoireLab Developers",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/88/34/c7d44b923f3c972df950c1fa4f92f381e962ef1bfec9693fd30ef575e50e/grimoirelab_toolkit-1.0.0.tar.gz",
"platform": null,
"description": "# GrimoireLab Toolkit [](https://github.com/chaoss/grimoirelab-toolkit/actions?query=workflow:tests+branch:master+event:push) [](https://coveralls.io/r/chaoss/grimoirelab-toolkit?branch=master)\n\nToolkit of common functions used across GrimoireLab projects.\n\nThis package provides a library composed by functions widely used in other\nGrimoireLab projects. These function deal with date handling, introspection,\nURIs/URLs, among other topics.\n\n## Requirements\n\n * Python >= 3.8\n\nYou will also need some other libraries for running the tool, you can find the\nwhole list of dependencies in [pyproject.toml](pyproject.toml) file.\n\n## Installation\n\nThere are several ways to install GrimoireLab Toolkit on your system: packages or source \ncode using Poetry or pip.\n\n### PyPI\n\nGrimoireLab Toolkit can be installed using pip, a tool for installing Python packages. \nTo do it, run the next command:\n```\n$ pip install grimoirelab-toolkit\n```\n\n### Source code\n\nTo install from the source code you will need to clone the repository first:\n```\n$ git clone https://github.com/chaoss/grimoirelab-toolkit\n$ cd grimoirelab-toolkit\n```\n\nThen use pip or Poetry to install the package along with its dependencies.\n\n#### Pip\nTo install the package from local directory run the following command:\n```\n$ pip install .\n```\nIn case you are a developer, you should install GrimoireLab Toolkit in editable mode:\n```\n$ pip install -e .\n```\n\n#### Poetry\nWe use [poetry](https://python-poetry.org/) for dependency management and \npackaging. You can install it following its [documentation](https://python-poetry.org/docs/#installation).\nOnce you have installed it, you can install GrimoireLab Toolkit and the dependencies in \na project isolated environment using:\n```\n$ poetry install\n```\nTo spaw a new shell within the virtual environment use:\n```\n$ poetry shell\n```\n\n## License\n\nLicensed under GNU General Public License (GPL), version 3 or later.\n",
"bugtrack_url": null,
"license": "GPL-3.0+",
"summary": "Toolkit of common functions used across GrimoireLab",
"version": "1.0.0",
"project_urls": {
"Homepage": "https://chaoss.github.io/grimoirelab/",
"Repository": "https://github.com/chaoss/grimoirelab-toolkit"
},
"split_keywords": [
"development",
" grimoirelab"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b7c8b6d1318635dcc8fc913e0faf0be5a41bd01703ac52d204b638aee574e6cb",
"md5": "bfe9bd6650e537e58cdfab0f1c79e86a",
"sha256": "8ee8502a4fd8e3144740653b3ab4deef7596c3275e50b69552b25edbc2e158e5"
},
"downloads": -1,
"filename": "grimoirelab_toolkit-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bfe9bd6650e537e58cdfab0f1c79e86a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.8",
"size": 20330,
"upload_time": "2024-04-13T07:21:54",
"upload_time_iso_8601": "2024-04-13T07:21:54.715600Z",
"url": "https://files.pythonhosted.org/packages/b7/c8/b6d1318635dcc8fc913e0faf0be5a41bd01703ac52d204b638aee574e6cb/grimoirelab_toolkit-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8834c7d44b923f3c972df950c1fa4f92f381e962ef1bfec9693fd30ef575e50e",
"md5": "810384ad4214f83052f09a52bccdb253",
"sha256": "331e67642ade3150cc9432fccd1197ab84350318d596739af92c49f5e371a0d1"
},
"downloads": -1,
"filename": "grimoirelab_toolkit-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "810384ad4214f83052f09a52bccdb253",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.8",
"size": 21358,
"upload_time": "2024-04-13T07:21:56",
"upload_time_iso_8601": "2024-04-13T07:21:56.335581Z",
"url": "https://files.pythonhosted.org/packages/88/34/c7d44b923f3c972df950c1fa4f92f381e962ef1bfec9693fd30ef575e50e/grimoirelab_toolkit-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-13 07:21:56",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chaoss",
"github_project": "grimoirelab-toolkit",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "grimoirelab-toolkit"
}
JSON
