A little toolkit with fancy functions
Project description
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)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for dktotoolkit-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | d878fbd95e53d82b614e85890d2f0fa5ac60772a0c06f98c15127040834114f6 |
|
MD5 | a9dadba2377440adbd3cddd3f9155599 |
|
BLAKE2b-256 | a1ef109d20bb9feccd0a4e7fa24231c4dfd545e7fdc06d5a16f36ffeb3d47c4d |