Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ajshedivy committed Aug 23, 2024
1 parent 7929574 commit b7daf29
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
<a href="https://github.com/Mapepire-IBMi/mapepire-python/actions">
<img alt="CI" src="https://img.shields.io/github/actions/workflow/status/Mapepire-IBMi/mapepire-python/main.yml">
</a>
<a href="https://pypi.org/project/python-wsdb/">
<img alt="PyPI" src="https://img.shields.io/pypi/v/python-wsdb">
<a href="https://pypi.org/project/mapepire-python/">
<img alt="PyPI" src="https://img.shields.io/pypi/v/mapepire-python">
</a>
<a href="https://github.com/Mapepire-IBMi/mapepire-python/blob/main/LICENSE">
<img alt="License" src="https://img.shields.io/github/license/allenai/tango.svg?color=blue&cachedrop">
Expand Down Expand Up @@ -33,28 +33,29 @@



## Overview

#### ⚠️ (WIP!) This Project is for demo purposes only
<img src="images/mapepire-logo.png" alt="logo" width="200"/>

## Overview
---

![alt text](images/image-1.png)

`mapepire-python` is a Python client implementation that leverages the [CodeFori Server Component](https://github.com/ThePrez/CodeForIBMiServer).
`mapepire-python` is a Python client implementation for [Mapepire](https://github.com/Mapepire-IBMi) that provides a simple interface for connecting to an IBM i server and running SQL queries. The client is designed to work with the [Mapepire Server Component](https://github.com/Mapepire-IBMi/mapepire-server)

## Setup

`mapepire-python` requires Python 3.9 or later.

### Install with `pip`

`mapepire-python` is available on [PyPi](https://pypi.org/project/python-wsdb/). Just Run
`mapepire-python` is available on [PyPi](https://pypi.org/project/mapepire-python/). Just Run

```bash
pip install python-wsdb
pip install mapepire-python
```

### Server Component Setup (Forthcoming)
### Server Component Setup
To use mapire-python, you will need to have the Mapepire Server Component running on your IBM i server. Follow these instructions to set up the server component: [Mapepire Server Installation](https://mapepire-ibmi.github.io/guides/sysadmin/)

## Example usage

Expand Down
Binary file added images/mapepire-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit b7daf29

Please sign in to comment.