https://github.com/smarie/python-parsyfiles
A declarative framework to read complex objects made of several files, supporting pluggable parsers and alternate file formats for the same object type. A typical use case is to read collections of test cases on the file system.
https://github.com/smarie/python-parsyfiles
benchmark class collection complex conversion converter dict file folder framework object parser parsing pep484 properties python simple type type-hint yaml
Last synced: 3 months ago
JSON representation
A declarative framework to read complex objects made of several files, supporting pluggable parsers and alternate file formats for the same object type. A typical use case is to read collections of test cases on the file system.
- Host: GitHub
- URL: https://github.com/smarie/python-parsyfiles
- Owner: smarie
- License: bsd-3-clause
- Created: 2016-12-09T17:14:17.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-10-11T16:45:54.000Z (over 6 years ago)
- Last Synced: 2025-03-19T21:17:50.203Z (4 months ago)
- Topics: benchmark, class, collection, complex, conversion, converter, dict, file, folder, framework, object, parser, parsing, pep484, properties, python, simple, type, type-hint, yaml
- Language: Python
- Homepage: https://smarie.github.io/python-parsyfiles/
- Size: 1.95 MB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# python simple file collection parsing framework (parsyfiles)
[](https://travis-ci.org/smarie/python-parsyfiles) [](https://smarie.github.io/python-parsyfiles/junit/report.html) [](https://codecov.io/gh/smarie/python-parsyfiles) [](https://smarie.github.io/python-parsyfiles/) [](https://pypi.python.org/pypi/parsyfiles/)[](https://kirankoduru.github.io/python/pypi-stats.html)
Project page : [https://smarie.github.io/python-parsyfiles/](https://smarie.github.io/python-parsyfiles/)
## What's new
* Travis and codecov integration
* Doc now generated from markdown using [mkdocs](http://www.mkdocs.org/)## Want to contribute ?
Contributions are welcome ! Simply fork this project on github, commit your contributions, and create_not_able_to_convert pull requests.
Here is a non-exhaustive list of interesting open topics: [https://github.com/smarie/python-parsyfiles/issues](https://github.com/smarie/python-parsyfiles/issues)
## Running the tests
This project uses `pytest`.
```bash
pytest -v parsyfiles/tests/
```You may need to install requirements for setup beforehand, using
```bash
pip install -r ci_tools/requirements-test.txt
```
## Generating the documentation pageThis project uses `mkdocs` to generate its documentation page. Therefore building a local copy of the doc page may be done using:
```bash
mkdocs build -f docs/mkdocs.yml
```You may need to install requirements for doc beforehand, using
```bash
pip install -r ci_tools/requirements-doc.txt
```## Generating the test reports
The following commands generate the html test report and the associated badge.
```bash
pytest --junitxml=junit.xml -v parsyfiles/tests/
ant -f ci_tools/generate-junit-html.xml
python ci_tools/generate-junit-badge.py
```### PyPI Releasing memo
This project is now automatically deployed to PyPI when a tag is created. Anyway, for manual deployment we can use:
```bash
twine upload dist/* -r pypitest
twine upload dist/*
```