Skip to content

document recommended environment and steps to get up and running quickly #38

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

document recommended environment and steps to get up and running quickly #38

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,27 @@ Currently this tool supports only PostgreSQL but we aim to add support for other

Requires Python 3.5 or newer.

## Installation
Get up and running quickly by using the steps below...

**Prerequistes**

Recommended to use **Fedora Linux Distrubution** or you might need to install additional packages/perform additional steps than those listed below
- Python 3.5 or newer
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Duplicates requirement above, could you remove it please from there?

- Python Pip
- Git
- make
- psycopg2-binary
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If pip cmd is already in the example, for the quick start could have also specified the command how to install it.
pip install psycopg2-binary
Actually binary is not required, psycopg2 is required, but whether to install it as binary or not, it's up to the user.


**Initialization**
```
$ git clone https://github.com/Sonoran-Software/aiven-db-migrate.git
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The link does not lead to the original version, it should be under aiven account.

$ cd aiven-db-migrate
$ make
$ pip install .
$ python3 -m aiven_db_migrate.migrate -h
```

## Usage

Running library module:
Expand Down