Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sylordis/csv-reorganiser
Small java tool to quickly reorganise csv files based on a yaml configuration file
https://github.com/sylordis/csv-reorganiser
csv-files csv-format jar java maven yaml
Last synced: 2 days ago
JSON representation
Small java tool to quickly reorganise csv files based on a yaml configuration file
- Host: GitHub
- URL: https://github.com/sylordis/csv-reorganiser
- Owner: Sylordis
- License: apache-2.0
- Created: 2020-11-26T17:11:23.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-22T11:52:03.000Z (8 months ago)
- Last Synced: 2024-05-22T12:55:00.279Z (8 months ago)
- Topics: csv-files, csv-format, jar, java, maven, yaml
- Language: Java
- Homepage:
- Size: 486 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# CSV Reorganiser
This utility tool allows you to produce quickly reorganised CSV from a YAML configuration definition.
## Description
Ever had to manipulate hundred of CSV files, change ordering from exports, or whatever to produce a final result? Then this tool was made for you.
Stop to the long hours trying to export, reorganise and separate fields values. All you need is Java and a YAML configuration file and that tool will make the job for you.
## Getting Started
### Dependencies
Java 21 is required for runtime.
This tool was made with/for Java 21 and Apache Maven as dependency manager.
It is using the following dependencies (already included as-is in the jar):
* [SnakeYAML](https://bitbucket.org/asomov/snakeyaml)
* [Apache Commons CSV](https://commons.apache.org/proper/commons-csv/)
* [Apache Commons Lang](https://commons.apache.org/proper/commons-lang/)
* [Apache Commons IO](https://commons.apache.org/proper/commons-io/)
* [Apache Log4J](https://logging.apache.org/log4j/2.x/)
* [Reflections](https://github.com/ronmamo/reflections)
Testing dependencies:
* [JUnit 5 (Jupiter)](https://junit.org/junit5/)
* [Mockito](https://site.mockito.org/)
* [Hamcrest 2](http://hamcrest.org/JavaHamcrest)
Documentation dependencies (by and for):
* [Javaparser](https://javaparser.org/)
Check the `pom.xml` file for dependencies versions.
### Compilation
Download the code, you should have Java 21+ and Apache Maven to be able to compile the project.
Follow typical Maven goals regarding your intention (`compile`, `package`, `install`, ...).
### Installing
Just download the jar file associated to the release or run `mvn package` (at least) from the repository.
Jar file should be provided under `target/csv-reorganiser-.jar`
### Executing software
Run the following command:
```
java -jar /csv-reorganiser-X.Y.jar
```
With:
* `yaml-cfg` the YAML configuration file to be used for the reorganisation. Examples are provided in the `examples/` folder, documentation provided on the [wiki](https://github.com/Sylordis/csv-reorganiser/wiki).
* `csv-sources` the base CSV files to be reorganised. If multiple ones are provided, they will all be processed sequentially and the results compiled into the same target file. Each source file must have the same structure.
* `csv-target` the target file to be written. If existing, it will be overwritten.
#### Engines
There are 2 engines in the CSV reorganiser. For each engine, the configuration file is written in a slight different way.
* The first one (id `1` or `chess`), is using a simple structure and performs only simple operations.
* The second one (id `2` or `hyde`), is an experimental engine using a text based definition of operations, with text filters directly included in the operation definition (still in implementation).
You can change which engine you are using by using the option flag `-engine ` or `-e ` where `` is the engine name or number.
You can also specify the engine in the configuration file via the header, using the tag `engine` which behaves the same as the option.
If no engine is specified, `chess` will be assumed.
Check the wiki for more information.
### Executing unit tests
A simple `mvn test` should suffice. This project has been built with the idea of achieving at least 80% of code coverage through unit tests.
If you want to skip unit tests to package or install, run command for installing (see before) with option `-DskipTests`.
## Help
Check out the [wiki](https://github.com/Sylordis/csv-reorganiser/wiki).
## Authors
* Sylvain Domenjoud aka "[Sylordis](https://github.com/Sylordis)" (creator and maintainer)
## Version History
* v1.1 - in progress (but usable with `chess` engine)
* Some unit tests were left behind (disabled).
* Multiple source files processing.
* New operation: Concat, Substring.
* Preparation for Hyde.
* v1.0
* First official release.
* Unit-tested (most of it) along with some integration tests.
* 3 Operations: Get, Value and RegReplace.
## License
This project is licensed under the Apache License v2 - see the LICENSE file for details
## Links
Project website:
# Known issues
Check the [wiki/Known issues](https://github.com/sylordis/csv-reorganiser/wiki/Known-issues).