# Generic Functionality used in the Common-EGSE
This package 'cgse-common' contains functionality that is used by all `cgse` sub-packages, but it is designed to be a stand-alone generic package that can be used also in any other project.
## Installation
Install the package using pip:
$ pip install cgse-common
## Usage
All functionality resides in the package `egse`. As an example, if you need a standard way to format your timestamp, use the `format_datetime()` function from `egse.system`:
>>> from egse.system import format_datetime
>>> print(format_datetime())
2023-10-10T08:41:51.937+0000
## Included Functionality
A non-comprehensive list of available functionality:
### Functionality of General Use
* **egse.bits**: contains a number of convenience functions to work with bits, bytes and integers
* **egse.decorators**: a collection of useful decorator functions
* **egse.reload**: a slightly better approach to reloading modules and function than the standard importlib.reload() function.
* **egse.resource**: provides convenience functions to use resources in your code without the need to specify an absolute path
* **egse.system**: defines convenience functions that provide information on system specific functionality like, file system interactions, timing, operating system interactions, etc.
* **egse.version**: functionality to retrieve the package version information
Raw data
{
"_id": null,
"home_page": null,
"name": "cgse-common",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "Rik Huygen <rik.huygen@kuleuven.be>, Sara Regibo <sara.regibo@kuleuven.be>",
"keywords": "CGSE, Common-EGSE, hardware testing, software framework",
"author": "IVS KU Leuven",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/ca/a8/8ec768f65c88f31e18b8da00bb86dadc363e790fa395398de17838240236/cgse_common-0.2.4.tar.gz",
"platform": null,
"description": "\n\n\n\n\n\n# Generic Functionality used in the Common-EGSE\n\nThis package 'cgse-common' contains functionality that is used by all `cgse` sub-packages, but it is designed to be a stand-alone generic package that can be used also in any other project.\n\n\n## Installation\n\nInstall the package using pip:\n\n $ pip install cgse-common\n\n\n## Usage\n\nAll functionality resides in the package `egse`. As an example, if you need a standard way to format your timestamp, use the `format_datetime()` function from `egse.system`:\n\n >>> from egse.system import format_datetime\n >>> print(format_datetime())\n 2023-10-10T08:41:51.937+0000\n\n\n## Included Functionality\n\nA non-comprehensive list of available functionality:\n\n### Functionality of General Use\n\n* **egse.bits**: contains a number of convenience functions to work with bits, bytes and integers\n* **egse.decorators**: a collection of useful decorator functions\n* **egse.reload**: a slightly better approach to reloading modules and function than the standard importlib.reload() function.\n* **egse.resource**: provides convenience functions to use resources in your code without the need to specify an absolute path\n* **egse.system**: defines convenience functions that provide information on system specific functionality like, file system interactions, timing, operating system interactions, etc.\n* **egse.version**: functionality to retrieve the package version information\n",
"bugtrack_url": null,
"license": null,
"summary": "Software framework to support hardware testing",
"version": "0.2.4",
"project_urls": null,
"split_keywords": [
"cgse",
" common-egse",
" hardware testing",
" software framework"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "d2750fdbfe3c7ef659845310a635efe24d33861bd9dfff8049869322ad79900c",
"md5": "a513bb514980950da8c7572c911ad3b9",
"sha256": "100d2be91fffcd44ce0b0fc18d1fa71a8efcd837e7eef3705da1bdf450822612"
},
"downloads": -1,
"filename": "cgse_common-0.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a513bb514980950da8c7572c911ad3b9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 118721,
"upload_time": "2025-02-07T22:43:17",
"upload_time_iso_8601": "2025-02-07T22:43:17.535886Z",
"url": "https://files.pythonhosted.org/packages/d2/75/0fdbfe3c7ef659845310a635efe24d33861bd9dfff8049869322ad79900c/cgse_common-0.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "caa88ec768f65c88f31e18b8da00bb86dadc363e790fa395398de17838240236",
"md5": "a2306f24c4299cbe593dc00fb5fc736a",
"sha256": "38b65d56aad0a7ed7f306f4f13568c8b9d416ffe409594381acef8f5f6dfea26"
},
"downloads": -1,
"filename": "cgse_common-0.2.4.tar.gz",
"has_sig": false,
"md5_digest": "a2306f24c4299cbe593dc00fb5fc736a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 103610,
"upload_time": "2025-02-07T22:43:18",
"upload_time_iso_8601": "2025-02-07T22:43:18.898610Z",
"url": "https://files.pythonhosted.org/packages/ca/a8/8ec768f65c88f31e18b8da00bb86dadc363e790fa395398de17838240236/cgse_common-0.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-07 22:43:18",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cgse-common"
}
JSON