Metadata-Version: 2.1
Name: dktotoolkit
Version: 1.1.0b1
Summary: A little toolkit with fancy functions
Home-page: https://discord-catho.frama.io/module_toolkit
Author: Pierre
Author-email: pierre@exemple.com
License: AGPL 3
Keywords: dotenv,.env,toolkit,parse dates
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.9
Classifier: Environment :: Console
Classifier: Operating System :: POSIX :: Linux
Classifier: Natural Language :: French
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: GNU Affero General Public License v3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.9, <4
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: bs4 (==0.0.1)
Requires-Dist: markdownify (==0.11.6)
Provides-Extra: doc
Requires-Dist: sphinx (==6.2.1) ; extra == 'doc'
Requires-Dist: sphinx-rtd-theme (==1.2.1) ; extra == 'doc'
Requires-Dist: myst-parser (==1.0.0) ; extra == 'doc'
Provides-Extra: test
Requires-Dist: coverage (==7.2.7) ; extra == 'test'
Requires-Dist: flake8 (==6.0.0) ; extra == 'test'
Requires-Dist: flake8-html (==0.4.3) ; extra == 'test'
Requires-Dist: html-report-line-profiler (>=0.1.1a) ; extra == 'test'
Provides-Extra: upload
Requires-Dist: twine (==4.0.2) ; extra == 'upload'
Requires-Dist: wheel (==0.40.0) ; extra == 'upload'

[![Latest Release](https://framagit.org/discord-catho/module_toolkit/-/badges/release.svg)](https://framagit.org/discord-catho/module_toolkit/-/releases)
[![pipeline status](https://framagit.org/discord-catho/module_toolkit/badges/main/pipeline.svg)](https://framagit.org/discord-catho/module_toolkit/-/commits/main)

---

[![coverage report](https://framagit.org/discord-catho/module_toolkit/badges/main/coverage.svg)](https://discord-catho.frama.io/module_toolkit/coveragepy_report/)
[![PEP8-Critical](https://img.shields.io/endpoint?url=https://discord-catho.frama.io/module_toolkit/badges/pep8-critical.json)](https://discord-catho.frama.io/module_toolkit/flake8_report/)
[![PEP8-NonCritical](https://img.shields.io/endpoint?url=https://discord-catho.frama.io/module_toolkit/badges/pep8-noncritical.json)](https://discord-catho.frama.io/module_toolkit/flake8_report/)
[![PEP8-Rate](https://img.shields.io/endpoint?url=https://discord-catho.frama.io/module_toolkit/badges/pep8-rate.json)](https://discord-catho.frama.io/module_toolkit/flake8_report/)
[![Profiling](https://img.shields.io/static/v1?label=Profiling&message=yep&color=informational)](https://discord-catho.frama.io/module_toolkit/profiler_report)

---

[![Downloads](https://pepy.tech/badge/dktotoolkit/month)](https://pepy.tech/project/dktotoolkit)
[![Supported Versions](https://img.shields.io/pypi/pyversions/dktotoolkit.svg)](https://pypi.org/project/dktotoolkit)

---

[![Catholic project](https://img.shields.io/static/v1?label=catholic&message=unofficial&color=orange&style=plastic&logo=feathub)]()

---

# 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)
