Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Improve README file with more details #40

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Docs: Improve README file with more details #40

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
86be147
docs: Improvement with more details
Sarrabah Jan 23, 2025
30e909f
refactor: Reorganize ideas
Sarrabah Jan 28, 2025
cd03a21
docs: Reorganize sections
Sarrabah Jan 28, 2025
ff330e3
Merge branch 'main' into docs/update-readme
Sarrabah Jan 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
# Fr-format

A collection of validators to check data against french formats.
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)

## Available formats

Check out [this documentantion](./docs/formats.md) that lists all available formats.

## Installation

Expand All @@ -10,6 +19,11 @@ The package is published on PyPI. Install with :

## Usage
Sarrabah marked this conversation as resolved.
Show resolved Hide resolved

**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 .

Comment on lines +22 to +25
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**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 .

Me semble redondant avec la phrase d'introduction.

Here's an example of how to use fr-format:
johanricher marked this conversation as resolved.
Show resolved Hide resolved
```python
from frformat import Departement, Options, Millesime

Expand All @@ -29,12 +43,7 @@ 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 documentantion](./docs/formats.md) that lists all available formats.

## Contributing

Found a bug, want to propose a feature or a new format? See the [contribution guidelines](./CONTRIBUTING.md) on how to proceed!


Loading