https://github.com/pyropy/exceliser
Exceliser is a tool for helping you serialize your excel documents to json or deserialize json back to excel document.
https://github.com/pyropy/exceliser
Last synced: 4 months ago
JSON representation
Exceliser is a tool for helping you serialize your excel documents to json or deserialize json back to excel document.
- Host: GitHub
- URL: https://github.com/pyropy/exceliser
- Owner: pyropy
- License: mit
- Created: 2020-04-15T19:18:42.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-21T18:36:53.000Z (about 6 years ago)
- Last Synced: 2025-06-22T05:34:56.498Z (12 months ago)
- Language: Python
- Homepage: https://pyropy.tech/
- Size: 76.2 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Excel JSON
> NOTE: This is still WIP so bugs might occure.
  [](https://deepsource.io/gh/pyropy/exceliser/?ref=repository-badge)
## Description
**Exceliser** is a tool for helping you **serialize** your excel documents to json or **deserialize** json back to excel document.
## Installation
To install this package simply run following command in your terminal:
```bash
pip install exceliser
```
## Usage via CLI
After installing the library on your machine (or virtual environment) you can serialize/deserialize documents via package CLI.
### Serialization
```bash
python -m exceliser --serialize --file test.xlsx --output-name test.json
```
### Deserialization
```bash
python -m exceliser --deserialize --file test.json --output-name test.xlsx
```
## Usage via importing the library
You can also import `exceliser` library directly to your scripts to help you with serialization/deserialization of excel documents.
### Serialization
```python
from exceliser.workbook import serialize
# serialize data to dict
data = serialize(path="/path/to/myworkbook.xlsx")
```
### Deserialization
```python
from exceliser.workbook import deserialize
# deserialize data from dict to worbook
workbook = deserialize(path="/path/to/mydata.json")
# save deserialized worbook as excel file
worbook.save('myworbook.xlsx')
```
## Development
### Running tests
To run all tests simply run following `make` command in your terminal:
```bash
make test
```
To see rest of the commands, including ones for running tests type following in the terminal:
```bash
make help
```
## Motivation
Serialization of excel documents to json makes them suitable for storing to database and deserialized when needed rather then keeping them as files.
## Author
* Srdjan Stankovic