https://github.com/arafatkatze/epson-connect-python

https://github.com/arafatkatze/epson-connect-python

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/arafatkatze/epson-connect-python
• Owner: arafatkatze
• License: other
• Created: 2023-10-02T19:54:48.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-20T21:58:25.000Z (about 1 year ago)
• Last Synced: 2024-04-13T14:20:12.083Z (8 months ago)
• Language: Python
• Size: 121 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Epson Connect

[![CI/CD](https://github.com/arafatkatze/epson-api-python/actions/workflows/cicd.yml/badge.svg)](https://github.com/arafatkatze/epson-api-python/actions/workflows/cicd.yml) [![Documentation Status](https://readthedocs.org/projects/epson-connect-api/badge/?version=latest)](https://epson-connect-api.readthedocs.io/en/main/?badge=latest)

The Epson Connect Library offers a comprehensive interface to the Epson Connect API. With this library, users can seamlessly control Epson printers and scanners through the Epson cloud service.

## Getting Started

## Installation of the library

```bash 

pip3 install epson-connect

```

## Prerequisites

Ensure that you have the required credentials:

- Printer Email

- Client ID

- Client Secret

These can be obtained from the Epson Connect API registration portal. For more detailed steps you can refer to the medium blogs from Epson.

## Usage

You can initialize the client using direct parameters:

```python

import epson_connect

ec = epson_connect.Client(

    printer_email='...',

    client_id='...',

    client_secret='...',

)

```

Alternatively, you can set up environment variables and initialize the client without parameters:

```

# export EPSON_CONNECT_API_PRINTER_EMAIL=

# export EPSON_CONNECT_API_CLIENT_ID=

# export EPSON_CONNECT_API_CLIENT_SECRET=

```

```python

ec = epson_connect.Client()

```

## Printing

```

job_id = ec.printer.print('./path/to/file.pdf')

```

For printing the following file extensions are supported 

```

doc

docx

xls

xlsx

ppt

pptx

pdf

jpeg

jpg

bmp

gif

png

tiff

```

## Scanning

```python

destinations = ec.scanner.list()

print(destinations)

```

### Tests

```

tox

```

This repository uses Github Workflows to run a CI CD pipeline it's defined in `.github/workflows/cicd.yml`

### Deployment

When you're ready to build and publish your library:

```

poetry build

poetry publish

```