[](https://framagit.org/discord-catho/module_toolkit/-/releases)
[](https://framagit.org/discord-catho/module_toolkit/-/commits/main)
---
[](https://discord-catho.frama.io/module_toolkit/coveragepy_report/)
[](https://discord-catho.frama.io/module_toolkit/flake8_report/)
[](https://discord-catho.frama.io/module_toolkit/flake8_report/)
[](https://discord-catho.frama.io/module_toolkit/flake8_report/)
[](https://discord-catho.frama.io/module_toolkit/profiler_report)
---
[](https://pepy.tech/project/dktotoolkit)
[](https://pypi.org/project/dktotoolkit)
---
[]()
---
# Module toolkit (package name : dktotoolkit)
This is a module with different tools, very usefull !
For exemple, there is :
* Load .env class
* Parser for dates
* Compatibility mode for function arguments
* Transformer de l'utf8 en HTML et de l'HTML en Markdown principalement.
* ...
# Documentation :
* Please read the documentation at : https://discord-catho.frama.io/module_toolkit
* Voir le fichier requirements.txt pour les dépendances, puis "$ make -C docs html" à la racine du projet
# Tag names
* "v" : for "version"
* vX.Y.Z : release (any bugs)
** release (X) : major new implementations
** macro-release (Y) : minor implementations, major improvements of features
** micro-release (Z) : bug correction, minor improvements of features (ex : add verbose)
* vX.Y.ZaN : alpha version (working version)
** Sync on git
** Continous integration
** Not upload on Pypi
* vX.Y.ZbN : beta release (must be fixed, or allmost)
** Sync on git
** Continous integration
** Uploaded on Pypi
* vX.Y.ZrcN : release candidate (all is fixed)
** Sync on git
** Continous integration
** NOT uploaded on Pypi
* vX.Y.ZpostN : post release (correction of doc)
** Sync on git
** Using CI
** Uploaded on Pypi
To have more informations, see PEP440 : https://peps.python.org/pep-0440/
# Installation
Installation en tant que module à partir des sources :
* Créer un environnement
```
$ python3.9 -m venv env_module
$ source env_module/bin/activate
```
* Installer le module avec les paquets de base
```
$ pip3 install .
```
* Installer le module avec tous les paquets de base
```
$ pip3 install .[doc, test]
```
* Installer uniquement les paquets
```
$ pip3 install -r requirements.txt
```
## Comme submodule
* Attention : il est nécessaire d'installer les dépendances également
```
$ cd /path/superprojet
$ mkdir -p scripts/external && cd scripts/external
$ git submodule add git@framagit.org:discord-catho/parserhtml.git
$ git submodule update --recursive --init
$ git submodule update --recursive --remote
```
# TODO
* [ ] submodule git pour CI et setup
* [ ] Add substitution inside .. literalinclude:: ../../dktotoolkit/__version__.py (setup.rst)
* [ ] Improve tests for parserhtml
* [ ] load dotenv : if path : check if exists, add argument : raise if not exists
* [ ] Transformer les fonctions de dktotk en sous-modules
* [ ] Fix pipeline, coverage
# Licence
GNU AGPL 3 (cf LICENCE.md)
Raw data
{
"_id": null,
"home_page": "https://discord-catho.frama.io/module_toolkit",
"name": "dktotoolkit",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9, <4",
"maintainer_email": "",
"keywords": "dotenv,.env,toolkit,parse dates",
"author": "Pierre",
"author_email": "pierre@exemple.com",
"download_url": "https://files.pythonhosted.org/packages/cc/ac/030c594fe67017b6d2dddb3d0dbd3b1b2e56c086da8cd6f590af9d62d52c/dktotoolkit-1.1.0.tar.gz",
"platform": null,
"description": "[](https://framagit.org/discord-catho/module_toolkit/-/releases)\n[](https://framagit.org/discord-catho/module_toolkit/-/commits/main)\n\n---\n\n[](https://discord-catho.frama.io/module_toolkit/coveragepy_report/)\n[](https://discord-catho.frama.io/module_toolkit/flake8_report/)\n[](https://discord-catho.frama.io/module_toolkit/flake8_report/)\n[](https://discord-catho.frama.io/module_toolkit/flake8_report/)\n[](https://discord-catho.frama.io/module_toolkit/profiler_report)\n\n---\n\n[](https://pepy.tech/project/dktotoolkit)\n[](https://pypi.org/project/dktotoolkit)\n\n---\n\n[]()\n\n---\n\n# Module toolkit (package name : dktotoolkit)\n\nThis is a module with different tools, very usefull !\n\nFor exemple, there is :\n* Load .env class\n* Parser for dates\n* Compatibility mode for function arguments\n* Transformer de l'utf8 en HTML et de l'HTML en Markdown principalement.\n* ...\n\n# Documentation :\n* Please read the documentation at : https://discord-catho.frama.io/module_toolkit\n* Voir le fichier requirements.txt pour les d\u00e9pendances, puis \"$ make -C docs html\" \u00e0 la racine du projet\n\n# Tag names\n* \"v\" : for \"version\"\n* vX.Y.Z : release (any bugs)\n** release (X) : major new implementations\n** macro-release (Y) : minor implementations, major improvements of features\n** micro-release (Z) : bug correction, minor improvements of features (ex : add verbose)\n\n\n* vX.Y.ZaN : alpha version (working version)\n** Sync on git\n** Continous integration\n** Not upload on Pypi\n\n* vX.Y.ZbN : beta release (must be fixed, or allmost)\n** Sync on git\n** Continous integration\n** Uploaded on Pypi\n\n* vX.Y.ZrcN : release candidate (all is fixed)\n** Sync on git\n** Continous integration\n** NOT uploaded on Pypi\n\n* vX.Y.ZpostN : post release (correction of doc)\n** Sync on git\n** Using CI\n** Uploaded on Pypi\n\nTo have more informations, see PEP440 : https://peps.python.org/pep-0440/\n\n\n# Installation\n\nInstallation en tant que module \u00e0 partir des sources :\n\n* Cr\u00e9er un environnement\n```\n$ python3.9 -m venv env_module\n$ source env_module/bin/activate\n```\n\n* Installer le module avec les paquets de base\n```\n$ pip3 install .\n```\n\n* Installer le module avec tous les paquets de base\n```\n$ pip3 install .[doc, test]\n```\n\n* Installer uniquement les paquets\n```\n$ pip3 install -r requirements.txt\n```\n\n\n## Comme submodule\n* Attention : il est n\u00e9cessaire d'installer les d\u00e9pendances \u00e9galement\n```\n$ cd /path/superprojet\n$ mkdir -p scripts/external && cd scripts/external\n$ git submodule add git@framagit.org:discord-catho/parserhtml.git\n$ git submodule update --recursive --init\n$ git submodule update --recursive --remote\n\n```\n\n# TODO\n* [ ] submodule git pour CI et setup\n* [ ] Add substitution inside .. literalinclude:: ../../dktotoolkit/__version__.py (setup.rst)\n* [ ] Improve tests for parserhtml\n* [ ] load dotenv : if path : check if exists, add argument : raise if not exists\n* [ ] Transformer les fonctions de dktotk en sous-modules\n* [ ] Fix pipeline, coverage\n\n# Licence\nGNU AGPL 3 (cf LICENCE.md)\n",
"bugtrack_url": null,
"license": "AGPL 3",
"summary": "A little toolkit with fancy functions",
"version": "1.1.0",
"project_urls": {
"Homepage": "https://discord-catho.frama.io/module_toolkit"
},
"split_keywords": [
"dotenv",
".env",
"toolkit",
"parse dates"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a1ef109d20bb9feccd0a4e7fa24231c4dfd545e7fdc06d5a16f36ffeb3d47c4d",
"md5": "a9dadba2377440adbd3cddd3f9155599",
"sha256": "d878fbd95e53d82b614e85890d2f0fa5ac60772a0c06f98c15127040834114f6"
},
"downloads": -1,
"filename": "dktotoolkit-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "a9dadba2377440adbd3cddd3f9155599",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9, <4",
"size": 53339,
"upload_time": "2023-09-19T22:51:47",
"upload_time_iso_8601": "2023-09-19T22:51:47.060801Z",
"url": "https://files.pythonhosted.org/packages/a1/ef/109d20bb9feccd0a4e7fa24231c4dfd545e7fdc06d5a16f36ffeb3d47c4d/dktotoolkit-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ccac030c594fe67017b6d2dddb3d0dbd3b1b2e56c086da8cd6f590af9d62d52c",
"md5": "0184ec8ca11a6bee58bac3b01e13b7b3",
"sha256": "1a65b4683a419331e65d83ba2317d1e7270f4fac9c2c9a3076b6d99fc32cfb23"
},
"downloads": -1,
"filename": "dktotoolkit-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "0184ec8ca11a6bee58bac3b01e13b7b3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9, <4",
"size": 46776,
"upload_time": "2023-09-19T22:51:49",
"upload_time_iso_8601": "2023-09-19T22:51:49.071550Z",
"url": "https://files.pythonhosted.org/packages/cc/ac/030c594fe67017b6d2dddb3d0dbd3b1b2e56c086da8cd6f590af9d62d52c/dktotoolkit-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-19 22:51:49",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "dktotoolkit"
}
JSON