Download the PHP package ubfr/c5tools without Composer
On this page you can find all versions of the php package ubfr/c5tools. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Package c5tools
Short Description COUNTER Release 5.x Tools
License Apache-2.0
Homepage https://github.com/ubfr/c5tools
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package c5tools
COUNTER Release 5.x Tools (c5tools)
C5tools is a PHP library for fetching, parsing and validating COUNTER reports and COUNTER API (formerly SUSHI) responses. The main features are:
- Support for COUNTER Release 5 and Release 5.1
- Support for COUNTER Reports and Standard Views in both JSON and tabular format
- Support for common extensions as specified in Section 11 of the COUNTER Code of Practice
- A COUNTER API client that supports all COUNTER API paths and parameters
- Generating validation reports in text, Excel and JSON format
- Parsed COUNTER reports and API responses are available for further processing
The c5tools were originally developed for the German National Statistics Service (NatStat) and later extended for performing the validation in the former COUNTER Validation Tool and now the COUNTER Validator.
Please see the COUNTER Metrics website, the COUNTER Code of Practice and the COUNTER API Specification for more information on COUNTER Metrics and the COUNTER standard.
Requirements
Running the c5tools requires PHP (8.2 or newer) and Composer for managing the dependencies.
Running the c5tools in a Docker container is also supported, in this case only Docker is required.
Installation via Packagist
PHP applications that use Composer can install the c5tools via Packagist by requiring the ubfr/c5tools package.
Running the Demo Scripts
For running the scripts in the demo directory please clone the project, install Composer in the project directory and run
to install the dependencies. Then run
to get a short help on using the demo scripts for validating COUNTER report files and COUNTER API requests and responses.
Running a Docker Container
The Docker setup was provided by @beda42, it is used by the COUNTER Validator and was tested with Docker 27.3 and 28.2. The Docker container provides a simple REST API for performing COUNTER report file and COUNTER API validations (see the public directory).
For creating and running the Docker container please clone the project and run
in the project directory. A request to validate a COUNTER report file in Excel format for example could be submitted with curl:
Note that the extension parameter in the URL must match the usual file extensions for the type of file submitted (e.g. json, tsv, csv, or xlsx). A COUNTER API validation can be performed by submitting the COUNTER API URL:
For better readability the response could be piped through jq .
All versions of c5tools with dependencies
ext-fileinfo Version *
guzzlehttp/guzzle Version ^7.10
nicebooks/isbn Version ^0.6
phpoffice/phpspreadsheet Version ^5.4