From 86be147024989d5ee04be469b77e77dd3de70c70 Mon Sep 17 00:00:00 2001 From: sarrabah Date: Thu, 23 Jan 2025 13:14:02 +0100 Subject: [PATCH 1/3] docs: Improvement with more details --- README.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 980749c..b0e0016 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,13 @@ # Fr-format -A collection of validators to check data against french formats. +The standard library `fr-format` has been developed for sharing validation functions between these two projects for now: + +* [validata](https://gitlab.com/validata-table) +* [csv-detective](https://github.com/datagouv/csv-detective) + +It provides a collection of validators to check data against typical French formats. + +## Usage ## Installation @@ -10,6 +17,11 @@ The package is published on PyPI. Install with : ## Usage +**User story** + +As a fr-format user, you want to validate a value according to a given French format. This allows you to easily check if the data provided by your project users is valid or not . + +Here's an example of how to use fr-format: ```python from frformat import Departement, Options, Millesime From 30e909f0842de69e3dd571a736515626b0194dd4 Mon Sep 17 00:00:00 2001 From: Ben Arbia Sarra <123973393+Sarrabah@users.noreply.github.com> Date: Tue, 28 Jan 2025 11:31:07 +0100 Subject: [PATCH 2/3] refactor: Reorganize ideas Co-authored-by: Pierre Camilleri <22995923+pierrecamilleri@users.noreply.github.com> --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b0e0016..9e636d0 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # Fr-format -The standard library `fr-format` has been developed for sharing validation functions between these two projects for now: +The standard library `fr-format` provides a collection of validators to check data against typical French formats. + +It has been initially developed for sharing validation functions between these two projects: * [validata](https://gitlab.com/validata-table) * [csv-detective](https://github.com/datagouv/csv-detective) -It provides a collection of validators to check data against typical French formats. - ## Usage ## Installation From cd03a21eadbb469d6ad7d0ee0865bb3cdc8a5c6c Mon Sep 17 00:00:00 2001 From: sarrabah Date: Tue, 28 Jan 2025 11:39:05 +0100 Subject: [PATCH 3/3] docs: Reorganize sections --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 9e636d0..2adbace 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,9 @@ It has been initially developed for sharing validation functions between these t * [validata](https://gitlab.com/validata-table) * [csv-detective](https://github.com/datagouv/csv-detective) -## Usage +## Available formats + +Check out [this file](./docs/formats.md) for a list of available formats. ## Installation @@ -41,6 +43,3 @@ For more details, consult the [Options](./src/frformat/options.py) data class. For better performance on big amounts of data, use in conjunction with numpy. -## Available formats - -Check out [this file](./docs/formats.md) for a list of available formats.